- fixed null pointer access in opensync's HasMultipleVEvents()
[barry.git] / ChangeLog
blob9da1b8cebafeacd19545ad352d4c410eb548beb8
1 Release: version 0.8 - 2007/05/??
2 ------------------------------------------------------------------------------
3 2007/07/13
4         - fixed null pointer access in opensync's HasMultipleVEvents()
5 2007/07/12
6         - upper management directive: revert all OpenSync 0.3x changes
7                 and proceed with OpenSync 0.22.  Reverting the
8                 opensync-plugin/src tree to Barry 0.7 status.
9 2007/07/06
10         - reorganized exception and trace code in opensync plugin
11         - added XmlToCalendar() function, based on unfinished opensync
12                 library API that is not yet finished... will be
13                 committed to opensync svn tree when complete
14         - added OSyncXMLField logger to plugin trace class
15 2007/06/29
16         - applied email MessageRecord patch from Brian Edginton (thanks!)
17         - updated Message::Dump() to output more valid mbox data...
18                 the goal is to be able to do:
19                         btool -d "Messages" > email.mbox
20                         mutt -f email.mbox
21         - changed some TODO's to FIXME's to keep it grep-consistent
22         - applied Folder support patch from Brian Edginton
23         - fixed pedantic compile warnings, and changed order in src/Makefile.am
24         - removed unneeded cast in src/r_folder.cc
25 2007/06/28
26         - minor adjustment to ctags building in buildgen.sh
27         - applied patch from Brian Edginton for better boost detection
28                 in configure.ac
29         - added boost usage message to btool -h output
30 2007/06/21
31         - more porting of OpenSync module to 0.30
32         - added ctags build for opensync source tree to buildgen.sh
33 2007/06/14
34         - changed PKG_CONFIG_PATH setting in rpm script, so that systems
35                 like SuSE that have an extensive PKG_CONFIG_PATH
36                 in general use will not break on build
37         - added PKG_CONFIG_PATH to debian script too, just in case :-)
38         - added debian/changelog to doc/ReleaseChecklist.txt
39         - added comment to rpm/barry.spec regarding SuSE RPM builds
40 2007/06/08
41         - applied patch from Niels de Vos fixing debian package build
42                 dependency
43         - applied Brian Edginton's Saved Email Messages patch
44         - updated r_saved_messages.cc comment to match header
45         - added GetRecType()/GetUniqueId() to r_saved_messages.h, since
46                 SetIds() is already there
47         - removed Address version of operator<<() from message related headers
48                 and moved into record.h
49         - added std::hex to message related dumps, and changed output to
50                 be more mbox-like
51         - updated doc/CodingStyle.txt to cover switch() statements
52         - opensync compiles again, with 0.30!  (not functional yet)
53                 - moving closer to more modular and reusable plugin functions
54         - updated release checklist for opensync version number
55 2007/06/07
56         - added doc/CodingStyle.txt... preliminary version
57 2007/06/06
58         - applied Brian Edginton's PIN message patch
59         - changes to PIN message patch:
60                 - fixed missing backslash in src/Makefile.am
61                 - fixed tab alignment throughout
62                 - removed typedef from Address struct
63                 - added clear() to Address... might as well, if it it is
64                         going to be a standalone type
65                 - fixed missing comma in PINMessageFieldLinks table
66                 - changed MessageRecordId in PINMessage to load from a new
67                         uint32_t field in CommonField, instead of piggy
68                         backing on a field for other use
69         - did some testing and found that PINMessage's MessageRecordId
70                 is the same as the RecordId given through the SetIds()
71                 API... but these Id's are duplicated in the protocol...
72                 RecordId is stored in the protocol header, while
73                 MessageRecordId is stored in the record it self as
74                 a common field... added RecType and RecordId to
75                 PIN Message so that we store both of these
76         - updated AUTHORS
77 2007/05/27
78         - added item to gui/TODO
79         - applied Brian Edginton's s11n-boost.h patch
80 2007/05/25
81         - renamed template values to more consistent naming scheme
82         - applied memos and tasks patch from Brian Edginton, slightly
83                 modified to split into the new separate files system
84         - changes to memos and tasks classes:
85                 - reformatted the code to match coding style
86                         (come on Brian) :-)
87                 - added copyright notice
88                 - changed class to singular (Memo, not Memos)
89                 - placed in Barry namespace
90                 - added #ifdef header protectors
91                 - added new files to Makefile.am
92                 - added new r_*.h headers to record.h
93         - added support for Memos and Tasks to tools/btool.cc, based on
94                 Brian Edginton's patch
95                 (currently commented out, for Boost library reasons):
96         - added doc/CommitPolicy.txt
97         - updated AUTHORS
98 2007/05/24
99         - added ctags generation to buildgen.sh
100         - applied record.{h,cc} fix patch from Brian Edginton
101                 - ClassFlag
102                 - FreeBusyFlag
103                 - Clear() fixes
104         - fixed broken formatting in above patch
105         - refactored record parser classes into separate files for each
106         - changed the ConvertHtoB<> template to inline, as it caused
107                 linker errors with the new file layout
108 2007/05/17
109         - fixed bug in Debian packaging that put util commands in
110                 /bin and /sbin instead of /usr/bin and /usr/sbin
111         - commited byteswap.h replacement code from gm2net
112         - backup gui:
113                 - removed unneeded debug messages on stdout
114                 - changed the default for debug output to "off"
115                         and added a command line option to turn
116                         it on if necessary  (--debug-output)
117                 - command line option --help now also works
118         - fixed bug in Calendar class where it didn't initialize
119                 RecType properly... and cleaned up other RecType
120                 code to use the GetDefaultRecType() functions,
121                 localizing the constants in one place
122 2007/05/11
123         - applied patches from Brian Edginton, parsing more
124                 fields in Contact and Calendar records
125         - added Brian Edginton to AUTHORS
126         - reformatted record.{h,cc} to match the rest of the code,
127                 removed commented out code, and removed mention of
128                 Outlook from the comments.
129         - updated udev/10-blackberry.rules.Debian for Debian Etch
130         - updated debian/rules to use new udev rules file
131         - removed debian/postinst, as stable versions of Debian now
132                 have a recent udev, and don't need the special handling
133         - updated Debian build scripts to build separate packages:
134                 libbarry
135                 libbarry-dev
136                 barry-util
137                 barrybackup-gui
138         - added menu support to Debian barrybackup-gui package
139         - made the buttons bigger in the backup GUI, as they were too
140                 small on Debian Etch
141         - opensync plugin:
142                 - more progress in porting to opensync 0.30, heavily
143                         based on the example plugin in the opensync
144                         svn tree...  this is a work in progress, and so far
145                         is incomplete
146 2007/05/04
147         - opensync plugin:
148                 - partial porting to opensync 0.30 (in progress!)
149                 - fixed bug in sync_done where it reported context error
150                         and then success afterward
151         - checking in new INSTALL files based on Etch's autoconf run
152         - added item to gui's todo list
153         - bumped version numbers to 0.8 in:
154                 - configure.ac
155                 - src/Makefile.am
156                 - src/version.cc
157                 - gui/src/BackupWindow.cc (about dialog)
158                 - src/Doxygen
159                 - rpm/barry*.spec
161 Release: version 0.7 - 2007/05/02
162 ------------------------------------------------------------------------------
163 2007/05/02
164         - added rpm building to maintainer/release scripts
165         - added "HEAD" feature to tarball creation script, for easier testing
166         - updated maintainer/README
167         - updated maintainer/release.sh to use new HEAD feature too
168 2007/05/01
169         - added pppob to rpm barry.spec
170         - bumped release number in barry.spec
171 2007/04/30
172         - opensync plugin:
173                 - fixed size check bugs (strlen() == 0 when empty)
174                 - finished refactoring calendar conversion routines
175                 - started timezone parsing, but this may go away
176                         if we use opensync 0.30's time functions and
177                         xml data format...
178                 - added development note to README
179 2007/04/29
180         - updated README and opensync-plugin/README with more current
181                 build instructions
182         - opensync plugin:
183                 - refactored some calendar conversion routines
184                 - added Barry->vCalendar conversion for recurring appointments
185 2007/04/27
186         - opensync module:
187                 - removed some unneeded trace logs
188                 - fixed VEventConverter constructor bug, with uninitialized
189                         m_Data pointer
190                 - eased up the requirement that every calendar event
191                         must have a summary... defaults to "<blank subject>"
192                         if empty
193                 - added more VCALENDAR fields to match Barry::Calendar record
194                 - fixed case sensitive compares in vformat.c
195 2007/04/26
196         - opensync module work:
197                 - added id map class to map string uid's from OpenSync to
198                         numeric ID's from the Blackberry
199                 - fixed bug in CommitChange() where it was still using
200                         a hard coded calendar record state table
201                 - added lots of logging throughout
202                 - fixed bug where newly added records didn't use the
203                         change object's uid, but created a new ID,
204                         causing another sync on the next run
205                         i.e. (CommitData_t was missing an argument)
206                 - fixed bug where uninitialized notification time was
207                         written to the Blackberry
208         - more opensync module work:
209                 - refactored the environment class into another subclass
210                         called DatabaseSyncState, and moved some stand-
211                         alone functions from barry_sync.cc into
212                         the environment classes
213                 - added a tagged constructor to the trace class
214                 - fixed idmap::Load() to clear map before loading
215 2007/04/20
216         - renamed barry-config to barry-sync, the default configuration
217                 file for the opensync module... and filled it with
218                 a sample configuration
219         - added code to update the calendar cache, and write it to disk
220                 on success (opensync module)
221         - added code to clear dirty flags in the device (opensync module)
222         - allowed comments in the config file
223         - added vformat.c from libopensync 0.22, since the vformat
224                 routines are not available from the plugin side
225 2007/04/19
226         - updated gui/TODO
227         - added -d switch to bcharge to switch back from 0001 to 0004 mode,
228                 changed the auto-detection logic to ignore iProduct and
229                 only use idProduct, and updated man page
230         - updated breset to recognize the Pearl in 00004 mode as well
231         - changed src/probe.cc logic to assume that the second endpoint
232                 pair is the one needed for database communication, instead
233                 of doing a reverse search from the end... newer Pearls
234                 in Dual mode seem to have at least 3 or 4 endpoint pairs,
235                 and the old search didn't always work
236         - applied sourceforge patch #1696884 from Peter Silva, updating
237                 the Debian build for Etch, and including all files in one deb
238         - added Peter Silva to AUTHORS file
239         - uncommented the "make distclean" in debian/rules, and removed
240                 the reliance on /tmp when installing 99-barry-perms.rules
241         - applied bb_task_format.txt patch from Peter Silva
242         - fixed each misspelling of "recurrance" to "recurrence"
243         - tweaked src/probe.cc again for paranoia's sake... start at
244                 offset 1 if more than 1 endpoint pair, otherwise start
245                 search at 0
246         - split up opensync module into multiple source files, and started
247                 using the opensync vformat routines for parsing and building
248                 the vevent20 data (experimental)
249 2007/04/04
250         - more incremental work on the opensync plugin, adding ADDED
251                 and MODIFIED functionality... (experimental!)
252 2007/03/30
253         - added code to dump extra descriptors during device discovery,
254                 if found
255         - bumped opensync version number in configure.ac, and made
256                 the configure scripts more consistent with the rest
257                 of the project
258         - fixed printf-format size bug in opensync module
259 2007/03/29
260         - applied patch from Niels de Vos, fixing deb udev rules for Pearl
261         - updated AUTHORS
262         - fixed extra space bug in LDIF output (added space when creating
263                 FullName, even if there was no last name)
264         - fixed Address Book record parsing in Contact class... the
265                 Blackberry database uses field id 0x20 for both the
266                 first and last names, and if only a last name exists,
267                 the first name will be empty.  Fixed parser to handle
268                 this special case, without relying on string length.
269                 Thanks to Troy Engel for reporting above two LDIF bugs.
270         - added a few more constants to bcharge.cc
271         - renamed opensync's configure.in to configure.ac
272 2007/03/17
273         - fixed bcharge to avoid endless reset loop... oops
274 2007/03/16
275         - reorganized bcharge.cc to make it possible to switch between
276                 Pearl modes 0004 and 0001
277         - added flag to BadPassword exception class, to signal whether
278                 the library considers the device "out of retries" or not
279         - updated socket.cc for new BadPassword exception
280         - added special case to Controller class destructor to reset the
281                 device if being destroyed in a half-open state... this is
282                 a temporary fix until we understand how to handle
283                 the "already open" message we get when opening the Desktop
284                 in some cases
285         - added password prompt dialog to the backup GUI
286         - fixed possible memory leak in GUI's DeviceInterface::Connect()
287 2007/03/08
288         - committed Troy Engel's bbrules_mass_symlinks.patch, fixing
289                 udev rules for the Pearl
290         - updated 10-blackberry.rules.Debian to match 10-blackberry.rules's
291                 functionality
292         - applied Troy Engel's barry.spec patch to generate all required
293                 RPM's... Thank you!  Notes in the README taken from
294                 the sourceforge tracker entry containing the patch.
295         - added libusb lib flags to tools/ and examples/ makefiles,
296                 and tweaked configure.ac with a better default,
297                 to build cleanly on RHEL 4
298         - modified rpm/barry.spec:
299                 - does not create doc-only barry base package anymore
300                 - fixed "barry-backup" typo
301                 - removed the patch step, as version 0.7 shouldn't need it
302                 - added license file to each package
303                 - commented out console perms scripts, pending mailing list
304                         discussion
305         - updated AUTHORS
306         - applied Troy Engel's barry.spec patch to fix RHEL4 compile issues
307         - fixed 80 column wrapping error in barry.spec, thanks to Troy Engel
308                 for the bug report
309         - applied Troy Engel's udev permissions patch for Redhat/Fedora
310                 systems, which automatically set the ownership of a
311                 newly plugged in device to the currently logged in console
312                 user.
313         - added udev/README to document what all those files are for...
314                 part of the text comes from the sourceforge comment
315                 on the above udev permissions patch from Troy Engel
316         - uncommented the console perms scripts for rpm/barry.spec
317         - added libglademm-2.4 to gui/README's dependency list
318         - made usbwrap.* calls more threadsafe
319         - added Usb::Timeout exception for timeout errors
320         - added preliminary UsbSerData support to library for GPRS modem
321                 functionality, using Rick Scott's XmBlackBerry's serdata.c
322                 as a guide
323         - added overloaded Socket::Send() for sending without receiving
324         - added preliminary pppob command line tool
325 2007/03/02
326         - version bump in:
327                 - configure.ac
328                 - src/Makefile.am
329                 - src/version.cc
330                 - gui/src/BackupWindow.cc (about dialog)
331                 - src/Doxyfile
332                 - rpm/barry.spec
333         - build system tweaks for opensync-plugin, and added a buildgen.sh
334                 for it
335         - added better debug messages in probe.cc and usbwrap.cc's
336                 device discovery code
337         - changed error handling for null interface->altsetting pointers
338                 when doing device discovery in usbwrap.cc.  Seems that
339                 some devices report a higher number in bNumInterfaces
340                 than are really available... in this case, let's
341                 just ignore the missing data and assume success
342         - applied udev script patch #1663986 from Troy Engel
343         - applied barry-bcharge.spec patch #1672178 from Troy Engel
344         - ReleaseChecklist update
345         - added rpm/README based on Troy Engel's patch notes
346         - updated new barry-bcharge.spec for version 0.7, removing patch
347                 dependency
349 Release: version 0.6 - 2007/02/28
350 ------------------------------------------------------------------------------
351 2007/02/28
352         - fixed size checks for device database records larger than 64K
353                 Thanks to Michael Brown for the bug report.
354         - added initial release maintainer scripts
355         - fixed odd backup success message in GUI when doing a backup with
356                 no databases selected in configuration
357                 Thanks to Michael Brown for the bug report.
358         - added udev permissions file patch from Michael Brown
359         - added Michael Brown to AUTHORS
360         - updated README, gui/README, and doc/USB-capture.txt
361         - added -o command line switch to bcharge.cc, and updated man page
362 2007/02/23
363         - changed library behaviour so it only turns on libusb debug output
364                 if in data dump mode.  In btool, -v controls this output.
365         - minor stream formatting fix in btool
366         - added OpenSSL dependency to build for password hash support
367         - made debug dout() output conditional on Init() flag... In btool,
368                 -v now controls this as well
369         - reverse engineered more of the initial probe packets, and
370                 implemented probing in struct based code... changes include:
371                 - added support for "attribute fetch" packets, used at
372                         the beginning of USB conversations
373                 - defined object/attribute id codes for the PIN number
374                 - made Protocol::SocketCommand more robust, and implemented
375                         its sequence number behaviour
376                 - moved ModeSelectCommand into SocketCommand, as it is a
377                         socket 0 level command
378                 - added initial protocol struct: PasswordChallenge
379                 - renamed Barry::Packet to DBPacket
380                 - added ZeroPacket for socket 0 packet creation and analysis
381                 - Barry::Packet is now the base class for the above
382                 - implemented socket 0 behaviour in socket.cc
383                 - changed return values for Send/Receive/Packet/NextRecord
384                         members in the Socket class from bool to void, as they
385                         don't generate errors themselves, but only can
386                         have an error if Usb::Device throws an exception.
387                         Cleaned up all code that called these members as well.
388                 - removed "last status" from Socket class as it was unused
389                 - updated probe.cc to use new socket 0 implementation
390                 - removed two of the hard coded packet handshakes in favour
391                         of socket 0 packets
392                 - updated controller.cc:
393                         - uses new socket 0 implementation
394                         - removed "flag" hack when opening sockets and
395                                 selecting modes, as it should use the
396                                 socket 0 sequence number
397         - added initial, incomplete prototype header for the C API
398         - updated some .cvsignore files
399         - updated TODO
400         - updated ReleaseChecklist.txt, adding rpm spec file
401         - added the following to ZeroPacket:
402                 - ChallengeSeed()
403                 - RemainingTries()
404                 - SocketResponse()
405                 - SocketSqeuence()
406         - moved Command() to base Packet class
407         - added comments to protostructs.h and size constants for the
408                 new PasswordChallenge struct
409         - added password support to Socket and Controller classes
410                 Thanks to Rick Scott's XmBlackBerry for the openssl
411                 password hashing logic.
412         - updated btool to use new password support, and updated its man page
413 2007/02/22
414         - updated Doxygen input files and version, and added to ReleaseChecklist
415         - fixed btool PIN output for LDIF mode, now commented in output
416         - major LDIF overhaul:
417                 - split LDIF specific code out of the record class and
418                         into its own
419                 - fixed "full name" behaviour that added an extra space
420                         in dn attributes, as reported by Troy Engel
421                 - added support for mapping of LDIF attributes to Barry
422                         contact field names
423                 - fixed base64 handling, so attributes are only so encoded
424                         if necessary
425                 - fixed base64 attribute reading inconsistency... some
426                         notes fields were missed in old version if not
427                         encoded
428                 - added support for specifying alternate attribute for
429                         constructing a FQDN, instead of just "cn"
430                 - updated btool and upldif to use new features
431         - large update to btool manpage
432         - fixed initialization bug in Contact constructor (missed RecType)
433 2007/02/15
434         - added ktrans.cc to make reading of kernel usbfs_snoop logs easier
435         - removed commented code from translate.cc
436         - added Pearl handshake support to bcharge.cc, which resets the
437                 Pearl so that the vendor specific 0xFF class exists.
438                 This should allow use of btool on the Pearl.
439         - added Data::AppendHexString to data.cc
440         - added better probing support for the Pearl, so it detects the
441                 Product ID 0x0004 mode, and does a search for class 0xFF
442                 instead of hardcoding it.
443 2007/02/10
444         - applied README patch from Ian Darwin
445         - minor tweaks to README
446         - added missing errno.h header in src/usbwrap.cc for AMD64
447                 Thanks to Jonathan Hudson for reporting the bug.
448         - tightened up size checks in Data::ReleaseBuffer()
449         - stable libusb *does* return the actual length of the USB packet...
450                 fixed this in usbwrap.cc to set the actual size of read data,
451                 and removed the size hacks elsewhere in the code:
452                 probe.cc, protocol.cc, socket.cc, usbwrap.cc
453 2007/02/09
454         - added proper return codes for error conditions in btool.cc
455         - clarified some stream output code in the library, for hex/dec numbers
456         - removed old, non-working connect.cc test program
457         - added iomanip to debug.h
458         - changed usbwrap to call libusb again if EINTR and EAGAIN
459                 This should fix one of the OpenBSD issues
460 2007/02/04
461         - updated AUTHORS
462         - fixed bug in barrybackup GUI that didn't create the target path
463                 if the user didn't do Edit | Config first.
464                 Thanks to Ian Darwin for reporting the bug.
465         - applied gui/src/ConfigFile.cc header fix patch for OpenBSD
466                 from Ian Darwin
467 2007/02/03
468         - added initial btool.1 man page from Ian Darwin
469         - updated man/Makefile.am for new btool.1
470         - updated AUTHORS
471         - applied btool -h help clarification patch from Ian Darwin
472 2007/02/02
473         - reworked exception hierarchy, so applications can handle all
474                 Barry related exceptions, including Usb errors, with
475                 one base class: Barry::Error
476         - fixed all the ripple changes this caused throughout the codebase
477         - added BadPassword exception
478 2007/02/01
479         - version bump in:
480                 - configure.ac
481                 - src/Makefile.am
482                 - src/version.cc
483                 - gui/src/BackupWindow.cc (about dialog)
484         - updated doc/ReleaseChecklist.txt
485         - added usb-level breset.cc command line tool
486         - fixed bug in gui/src/tarfile.* for systems where
487                 sizeof(int) != sizeof(void*)
488                 - TarFile class now uses a plugin style for the compression
489                         operations, to allow for threadsafe versions if needed
490                         in the future.
491                 - also fixed leaked file handle bug in open_compressed()
492                 - Thanks to Jonathan Hudson for reporting this for 64bit systems
493         - minor signed comparison fixes in the library
494         - added better protocol data dumping code in probe.cc
495         - added Usb::Device::BulkDrain(), to prevent Barry from hanging
496                 due to pending reads
498 Release: version 0.5 - 2007/01/26
499 ------------------------------------------------------------------------------
500 2007/01/26
501         - added missing errno.h header to gui/src/util.cc
502         - lots more endian fixes after testing on iMac  
503         - iostream output size fixes
504         - added option to btool to reset the device via software
505         - beefed up exception handling in barrybackup
506         - checked in opensync work-in-progress: trace logging, pointer bugfix
507                 this is still experimental
508         - added aboutdialog.* files from gtkmm24 2.10.6, so we have a dialog
509                 class for systems running older versions of gtkmm, like
510                 Debian stable
511         - uncommented the about box menu handler
512         - added "cleanall" option to root buildgen.sh script
513         - update ReleaseChecklist.txt
514         - removed CVS auto-history strings from aboutdialog.*
515 2007/01/25
516         - found a link between the unknown field in tagged protocol headers
517                 and the unknown field in RecordStateTable entries.  This
518                 field matters when uploading certain databases, such as
519                 Browser Options.  It is unknown what this field really
520                 means, but we're calling it RecType.  Updated the API
521                 to use this in all parser objects and builder objects
522                 and record objects that use it.
523         - changed some uses of uint64_t to uint32_t, in Contact and
524                 Calendar record objects... unique IDs only seem to be
525                 32 bits
526         - added new static function to record classes: GetDefaultRecType()
527                 This returns the default rectype that should work
528                 for that record.  Ideally this should be retrieved from
529                 the device, but in the case where a database has no
530                 records, this info would be good to know.
531         - updated convenience template function Controller::AddRecordByType()
532                 to use GetDefaultRecType()
533         - documented the recurrence data and how to use it in Calendar objects
534         - added data debug output for incoming USB packets in the
535                 socket class... when we ported to the stable libusb
536                 we lost some of the verbose output... this should get it
537                 back.  (In the official release, you need to uncomment
538                 ddout() in debug.h for the full blast of debug output).
539         - backup GUI updates:
540                 - changed error_done signal into a pure error signal,
541                         and changed the logic so the restore continues
542                         even if there was a protocol error on one database
543                 - changed status bar messages to show what's happening
544                         i.e. Backup or Restore
545                 - default to not restore the "Handheld Agent" database as
546                         it appears to be read-only on the device
547                 - added temporary Restore & Backup mode for debugging
548                 - added extra hyphen to backup files to show date/time better
549                 - updated GUI to save and restore the new RecType field
550                         supported now by the library
551 2007/01/21
552         - added future considerations to doc/ReleaseChecklist.txt
553         - applied big endian patch from Jonathan Hudson
554         - changes to patch:
555                 - removed endian.h include from barry.h, since applications
556                         using the library should not care about endianness
557                 - hard coded the path to config.h in endian.h
558                         so that endian.h never makes it into the final
559                         install
560                 - removed DEFAULT_INCLUDES setting from src/Makefile.am
561                         for the same reason
562                 - removed config.h dependency in btool.cc and used library
563                         Version call instead
564         - added big/little endian text to the Barry::Version call
565         - updated AUTHORS
566         - fixed install location of bcharge when building with ./configure;
567                 now goes to sbin/ for both source compile and binary packages
568                 Thanks to Jonathan Hudson for reporting this bug.
569 2007/01/20
570         - added smarter timeout values to controller, and allowed
571                 timeout overrides in the packet, socket, and usbwrap code...
572                 extra timeouts are needed for erasing databases for
573                 some older devices
574         - added an explicit DataDumpParser class to btool.cc, as the
575                 library doesn't always have extreme verbose debugging on...
576                 this makes sure anyone can always get raw database packets
577                 through btool, for development
578         - added thread callback signals for error finishes and erase_db
579                 operations, so the GUI is updated properly
580         - more GUI cleanups (status bar updates, etc)
581         - finished implementation of GUI restore
582         - fixed gtkmm/glibmm exception handling when the exceptions
583                 occur in sigc signal handlers... in that case,
584                 exceptions need to be handled with
585                 Glib::add_exception_handler()
586         - added filename-only reading support to TarFile class
587         - added pending gui/TODO items
588 2007/01/19
589         - backup GUI now properly shows progress
590         - the buttons become insensitive when backup is busy
591         - refactored directory check code, and added mkdir check
592                 when to the backup setup (so the directory exists
593                 when we try to write to it)
594         - updated code to use Barry::Data in new namespace
595 2007/01/18
596         - moved Data class into Barry namespace
597 2007/01/13
598         - updated copyright dates for the new year
599         - clarified exception message in controller.cc
600         - fixed pointer initialization bug in controller.cc
601         - added documentation comments to parser.h and builder.h
602         - updated ReleaseChecklist.txt
603         - updated README
604         - changed Barry library configure scripts to make better
605                 use of pkg-config for autodetecting dependencies
606         - added initial Barry Backup GUI (gui/ directory), capable of making
607                 backups only at this point
608 2007/01/11
609         - added doc/ReleaseChecklist.txt
610         - added version API, returning version number and string
611         - added Troy Engel to AUTHORS
612         - added special case to bcharge.cc for the Blackberry Pearl,
613                 which doesn't reset itself after the charge handshake
614                 Thanks to Troy Engel for testing.
615 2007/01/05
616         - added pkg-config support for the library (libbarry-0.pc.in)
617         - fixed compile error on g++ 3.3 systems (missing stdint.h
618                 in probe.h)
619         - fixed protocol hang at end of Controller operation... in
620                 controller destructor, it was deleting the USB interface
621                 before closing the socket at the BlackBerry level, thereby
622                 leaving the device in Desktop mode
623 2007/01/04
624         - support the newer udev packages on Ubuntu, which need slightly
625                 different rules
626         - modified bcharge.cc to search for Pearl devices too.
627                 USB product ID 6
628         - added Pearl product ID to probe code, but likely not functional
629                 yet until we find someone able to get a USB capture for us
630 2006/12/29
631         - version bump in configure.ac and src/Makefile.am
633 Release: version 0.4 - 2006/12/29
634 ------------------------------------------------------------------------------
635 2006/12/29
636         - added bcharge.cc to the tools/ directory (whoohoo!)
637         - added initial release version of rpm/barry.spec (aka bcharge.spec)
638                 This begins the barry binary release, currently only
639                 including the bcharge utility, but possibly more in
640                 the future.  Future binary packages will likely include
641                 libbarry, libbarry-devel, etc, which barry will then
642                 depend on.
643         - added udev rule script for BlackBerry devices
644         - added man/ directory and bcharge.1 manpage
645         - added debian/ directory for building deb packages, with initial
646                 package scripts
647         - added rpm/make-rpm-tarball.sh for building RPMs
648         - split out technical docs into separate libbarry.docs file for
649                 a future Debian install
650         - added more cleaning to buildgen.sh
651         - added new udev rule file for Debian stable
652         - hardcoded g++ to 3.3 in debian/rules as I have multiple versions
653                 on my system and need to compile releases with stable
654 2006/12/21
655         - ported Barry to use the stable branch of libusb
656                 NOTE: no longer depends on the devel libusb tarball!
657                         Just use your distro's libusb packages.
658         - fixed more endian issues
659         - minor update to TODO
660 2006/12/15
661         - moved Exceptions, Hacking, and VersionNotes to doc/
662         - added doc/USB-capture.txt
663 2006/12/08
664         - added Controller::AddRecord() and template helper
665         - added beginning version of generic RecordFetch<> template
666         - set default of Barry::Init() to false (no data dump mode)
667         - added examples/ directory, with first addcontact.cc example
668 2006/12/07
669         - added autoconf support based on Peter McAlpine's patch
670         - renamed Makefiles to Makefile.orig and added script to turn
671                 on old build system if wanted
672         - fixed boost-specific error path in btool
673         - moved platform specific code out of time.h and into time.cc
674         - moved btool.cc, translate.cc, and upldif.cc out of src/ and
675                 into their own tools/ subdirectory
676         - added NEWS file to make autotools happy
677         - added a "clean" option to the buildgen.sh script... maintainer's
678                 use only
679         - reworked autoconf and automake files, to support
680                 barry as a library, to move the programs into their
681                 own tools directory, and support a proper installation
682         - fixed headers in parser.h, btool.cc, and upldif.cc to work
683                 properly when installed standalone
684         - added tools/Makefile.plain for testing compiling against
685                 installed barry library
686         - added commentary on version number system
687         - removed Makefile.conf and Makefile.orig, as new autoconf
688                 system supercedes it
689         - added support for boost serialization library in autoconf build
690         - added library version number to autoconf build
691         - changed boost flag to __BARRY_BOOST_MODE__ to avoid collisions
692         - removed debug.h dependency from btool.cc
693         - removed libusb check in favour of specific --with-libusb
694                 option... may need to revisit this later
695         - quick installation update in README
696 2006/12/01
697         - fixed some missed endian conversions in record.cc and added
698                 some size checks
699         - fixed endian issues in time.h
700         - added 2 more functions to the time zone API, and adjusted
701                 the time zone table for better defaults in North America
702         - added btool and upldif to the make install sequence
703         - added support for Calendar recurrence data
704         - small doc/TimeZones.txt update
705 2006/11/24
706         - added BlackBerry time zone code list, reverse engineered from a 7750
707         - added GetTimeZone() to convert device time zone codes to useful data
709 Release: version 0.0.3 - 2006/11/24
710 ------------------------------------------------------------------------------
711 2006/11/23
712         - added return code check to Controller::SaveDatabase()
713         - fixed Data() class constructor, so it doesn't auto-convert
714                 from any int
715         - fixed size checking bug in Packet::ReturnCode() that caused
716                 uploading to device to fail
717 2006/11/10
718         - added Exceptions doc file, documenting the C++ exceptions used,
719                 and their hierarchy
720         - fixed small bug in 'make install' which didn't build first
721         - minor documentation and cleanup in upldif.cc
722         - added utility functions to the RecordStateTable class,
723                 GetIndex() and MakeNewRecordId()
724         - changed btool so that the -d command modifiers can be
725                 specified multiple times to work with multiple records
726                 at once
727         - added Calendar sync code to the opensync module (not complete)
728         - cleaned up exception handling in the opensync module, making
729                 more use of the base exception to make sure no
730                 exceptions leak into the C library code
732 Release: version 0.0.2 - 2006/10/12
733 ------------------------------------------------------------------------------
734 2006/10/12
735         - fixed casting error in opensync module
736         - minor updates to documentation to prepare for release
737 2006/09/29
738         - added stdint.h to parser.h for uint32_t.  Thanks Ron Gage for
739                 the bug report
740 2006/09/08
741         - large refactoring of the packet parsing and building code,
742                 splitting the code into 3 groups:
743                 - record: handles record specific parsing and building...
744                         this is mostly subfields with CommonField structs
745                         as their headers, but sometimes has a specific
746                         header of its own, in the case of email
747                         Note: email's header is as yet undecoded.
748                         Record does not know the details of the packet
749                         formats, only the formats of its own record data.
750                 - packet: handles building of complete command packets
751                         and handles parsing of commonly used header values,
752                         providing an API for it... packet does not know
753                         the record format details, but does know the
754                         details of each Database Operation (protocol.h)
755                         packet format.
756                         So far, it seems that there is a real separation
757                         of operation formats and record formats, with the
758                         record formats being the same even with different
759                         database operation codes (GET_RECORDS /
760                         OLD_GET_RECORDS), which was not confirmed before.
761                         See the header size of the email record after
762                         refactoring.
763                 - controller: handles device state, and the management of
764                         sockets, commands, and checking for response values.
765                         The Controller object does not know the format
766                         of either the record or the packet it is sending,
767                         but does know the protocol handshake logic used
768                         to talk to the device.
769         - implemented SetRecord (SET_RECORD_BY_INDEX)... syncing, here
770                 we come!
771         - spelling correction in opensync-plugin/AUTHORS
772 2006/09/01
773         - added sample hotplug scripts
774         - added .cvsignore files for doxygen and opensync directories
775         - added src/endian.h... still need to add configure support to
776                 handle non-little-endian machines
777         - added exception handler in opensync plugin commit_change()
778         - removed the device reset code in probe.cc, as resetting a device
779                 can renumber the devices in /proc on kernel 2.4.x,
780                 and cause a failure to reach the device...
781                 FIXME - this should be changed someday to reset if probing
782                 fails, and restart the probe on reset, as sometimes
783                 the blackberry devices respond differently when not reset
784                 Ideally, the probe protocol should be properly reverse
785                 engineered.
786         - added support for retrieving record state table, which is needed
787                 for smarter syncing
788         - added support for retrieving, deleting, and clearing the dirty
789                 flags of individual blackberry device records
790         - added endian macros throughout the code
791 2006/07/13
792         - added opensync-plugin to root Makefile's clean
793         - updated time conversion calls to match opensync's latest SVN
794         - added opensync_change_set_changetype() (only add for now,
795                 for development)
796         - removed slow sync functions for now
797 2006/07/07
798         - added quick "install" makefile target, to src/install by default
799         - added static library target... this is temporary until autoconf
800                 stuff is added properly... needed for the opensync plugin
801         - documented in comments that Barry::BError is intended to be
802                 the base classes for all exceptions
803         - added first round of implementation of an opensync plugin, based
804                 on the example plugin code from the opensync sources
805 2006/06/22
806         - added to Contact record class:
807                 - Clear()
808                 - ReadLdif() to load and parse LDAP data
809         - added fragmented send support to Socket class
810         - added Probe::FindActive() to make client programs more streamlined
811         - fixed hex/decimal printing of record counts in btool
812         - added upldif.cc, a utility to take ldapsearch output on stdin
813                 and upload it to a blackberry
814         - updated src/.cvsignore
815 2006/06/16
816         - added parsing of service book fields:
817                 - old and new name
818                 - old and new unique ID (UID)
819                 - content ID (CID)
820                 - old and new description
821                 - DSID
822                 - bes domain / domain
823         - date change in legal.txt
824         - added initial parsing of ServiceBook field 0x09, and calling it
825                 ServiceBookConfig for now, for lack of a better name
826         - added parsing for ServiceBook field 0x02 on 72xx Blackberries...
827                 seems to be a name or description, but doesn't appear
828                 in the device's own GUI... called "Hidden Name" for now
829 2006/06/09
830         - added ServiceBook record class and parser code, based on some
831                 of Ron Gage's reverse engineering... code is by Chris Frey
832         - added AUTHORS file
833         - fixed the libusb set_configuration/claim_interface order
834                 bug in controller.{h,cc}... already fixed in probe,
835                 but not controller.  Thanks Ron Gage for finding this.
836 2006/05/25
837         - renamed Changelog to ChangeLog in preparation for autoconf
838         - renamed Todo to TODO in preparation for autoconf
839 2006/05/18
840         - make clean cleans up tests properly now
841 2006/03/31
842         - turned source code browsing on in Doxyfile
843         - added LoadDatabaseByName() and LoadDatabaseByType() template members
844                 to the Controller class
845                 - new file: controllertmpl.h
846         - documentation fixes in builder.h
847         - added static GetDBName() functions to all record classes, in
848                 support of the template Controller functions
849         - fleshed out DatabaseDatabase::GetDBNumber() and GetDBName(),
850                 returning errors properly
851         - documented sample btool.cc code better, and added example
852                 of Controller template member usage
853 2006/03/29
854         - copyright dates updated for 2006
855 2006/01/05
856         - backed out update to latest libusb DEVEL tree, since it is buggy.
857                 Stick with libusb 2005/11/26
858 2005/12/30
859         - added clean target to convenience Makefile
860         - added Boost to list of dependencies in README
861         - fixed minor compile warnings in base64.cc
862         - fixed new USB discovery code, and changed endpoint usage to use
863                 it, instead of the READ_ENDPOINT and WRITE_ENDPOINT
864                 constants... constants are now removed
865                 common.h, controller.cc, probe.cc, probe.h, usbwrap.cc
866         - added ClearHalt() to Usb::Device (usbwrap.cc)
867         - updated usbwrap.h to match latest libusb CVS devel tree
868         - updated README to refer to 2005/12/30 libusb CVS devel tree
869         - added roadmap to Todo list
870 2005/12/29
871         - added convenience Makefile in root directory
872         - added Hacking document
873         - minor touchups to README
874         - added caution warning to README, since this release will support
875                 delete / overwrite / upload functionality
876         - minor compile order change in Makefile (speed reasons)
877         - added dynamic endpoint discovery to probe.cc
878         - changed claim_interface/set_configuration() function call order in
879                 probe.cc based on feedback on the libusb mailing list
880         - added USB discovery code to usbwrap.{h,cc}
881 2005/12/23
882         - fixed packing bug in new upload header struct
883         - renamed CommonField union from data to u to be consistent
884         - added return_code field to DBAccess struct, for error checking
885         - added response checking during upload: if response is non-zero
886                 throw exception in controller.cc
887         - added sorting operators to record parser classes... when writing
888                 contact data to the device, it may be important to write
889                 group link items last, since they reference other contacts...
890                 This needs to be tested, and if not required, removed.
891         - added GROUP_FLAG field code to Contact parser class
892         - fixed offset bug in Contact and Calendar Build() functions
893         - fixed name bug in Contact::Build(), now output only with data
894         - added appointment type flag support to Calendar record parser
895                 class, and "all day event" flag support
896 2005/12/22
897         - added autoconf to Todo list
898         - refactored the protocol structures so that record structs can
899                 be reused for upload and download
900         - with new protostructs, more header control is handled by
901                 controller.cc instead of record.cc parsers and builders
902         - parser code now accepts an offset, to govern start of record data
903         - changed Data sizes from int to size_t and removed casts
904         - removed unneeded Parser::GetHeaderSize() (new protostructs make
905                 this obsolete)
906         - added Calendar::Build() for calendar uploads
907 2005/12/10
908         - added s11n-boost.h serialization templates for boost::serialization
909         - added boost::serialization to build
910         - minor change in usbwrap.cc to display error codes in decimal
911         - added SizePacket special case code to Socket::Send()... this is
912                 required when uploaded packet size is a multiple of 0x40,
913                 a special 3 byte size packet is sent
914         - moved some record class variables to public: so they can be
915                 properly serialized
916         - fixed variable name but in RecordBuilder template
917         - added -f switch to btool, for saving and loading of record data
918         - added -s switch to btool, for uploading saved data back to handheld
919         - added Controller::SaveDatabase()
920 2005/12/08
921         - fixed potential casting / pointer bug in controller.cc
922         - added builder.h, to support uploading
923         - minor comment fixes in parser.h
924         - added preliminary Contact protocol record building support
925         - fixed field order bug in ContactRecord protocol struct
926         - Contact record.h class now saves unknown Group Link field,
927                 for later saving
928 2005/12/07
929         - added -fno-strict-aliasing to compiler flags so gcc-4.0.x won't
930                 optimize away protocol struct casts
931                 see: 
932                 http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25235
933                 http://mail-index.netbsd.org/tech-kern/2003/08/11/0001.html
934                 http://groups.google.ca/group/comp.lang.c++.moderated/ \
935                         browse_thread/thread/e7bf096832526f8e/5714701b \
936                         02a2a3cc?hl=en#5714701b02a2a3cc
937         - changed headers so that any low level protocol-specific sizes and
938                 structs are completely hidden in the library...
939                 this adds library-only header: protostructs.h
941 Release: version 0.0.1 - 2005/11/25
942 ------------------------------------------------------------------------------
943 2005/11/25
944         - added barry.h for documentation purposes and application usage
945         - updated README for release
946         - renamed SBError exception class to BError
947         - updated Doxyfile to version 1.4.5
948         - added more doxygen comments
949 2005/11/24
950         - added conversion routines (and tests) between time_t and min1900_t
951         - added -v option to btool to dynamically control protocol dumping
952         - removed duplicated database database table display in controller.cc
953         - minor spelling corrections
954         - added copyright to usbwrap.{h,cc} as per earlier meeting
955         - added support for Old protocol Calendar entries
956 2005/11/20
957         - added legal.txt, to save typing when adding new source files
958         - ignore test-base64 file (cvsignore)
959         - added contact-to-ldif generation, and updated supporting code
960         - added argument to btool to support contact-to-ldif operation
961         - added Contact::GetPostalAddress()
962         - added README documentation in preparation for future release
963 2005/11/19
964         - added parser.{h,cc} virtual wrapper to generalize LoadDatabase()
965         - added code to socket.cc's Packet() command to re-receive on
966                 reception of empty packets... this seems to be a signal
967                 from the device that it needs more time for long transfers
968                 Current limit: 10 blank packets before exception is thrown
969                 Observed maximum blank count: 1
970         - added MessageRecord and OldMessageRecord to protocol.h
971         - changed common record field structs to one CommonField struct
972         - increased default USB timeout to 10 seconds (some loaded devices
973                 seem to need more time...)
974         - reorganized record.{h,cc} to try to reduce the code duplication
975         - record.h classes now "know" the sizes of their corresponding
976                 protocol structs... this may cause trouble down the line
977                 with Python, if used(?)
978         - added Message class for Email records
979         - removed the "Get*" database functions and replaced with
980                 general LoadDatabase() call, which loads any database
981                 available, and parses it with a Parser object
982         - added GetDBID() for searching for database numbers via name
983         - added test code to retrieve and display all email
984         - cleaned up comments
985         - renamed blackberry.{h,cc} to controller.{h,cc}
986         - renamed bbtool.cc to btool.cc
987         - added Makefile.conf
988         - added copyright notices to source files
989         - added COPYING file with GPL
990         - put parser in Barry namespace, and added auto_ptr-like mode for
991                 store object pointers
992         - added doxygen docs
993         - added header comments to convo.awk script
994         - removed Test() function in Controller object, and made class
995                 better suited to its general API purpose
996         - changed OpenMode() so it loads command table and DBDB... it is now
997                 a public API function
998         - moved Controller test code to btool.cc and made tool more
999                 generically useful... can now download any DB by name on
1000                 the command line
1001         - added mode checks to Controller
1002         - added -t and -d command line options to btool
1003         - added base64 routines from John Walker / Fourmilab and Citadel/UX
1004         - converted base64 routines into an API, instead of hardcoded
1005                 file based
1006 2005/11/18
1007         - changed project name to Barry, including namespaces
1008         - renamed sbcommon.* to common.*
1009         - increased USB default timeout to 2 seconds
1010         - fixed formatting bug in Data operator<< output
1011         - cleaned up the protocol packet structs, getting rid of the
1012                 confusing param/simple split... param is now the tableCmd
1013                 from the Command Table
1014         - moved protocol structs from record.h to protocol.h
1015         - added support for older version of the USB protocol, which matches
1016                 the Cassis spec more closely
1017         - fixed the hardcoded offsets in blackberry.cc's protocol parsing
1018         - fixed Socket::Close() so on error, socket flags are reset.
1019                 This stops Close() from being called twice on exception
1020                 destructors
1021 2005/11/17
1022         - added Doxyfile to the project
1023         - tuned Makefile
1024         - added mode selection support to Blackberry class (RIM Desktop,
1025                 RIM Bypass, and RIM_JavaLoader)
1026                 Mode selection governs which socket is used in subsequent
1027                 data transfers.
1028         - added Command Table parsing and protocol support
1029                 Blackberry class, and CommandTable record class
1030         - added Database database parsing and protocol support
1031                 Blackberry class and DatabaseDatabase record class
1032         - added Address book retrieval support - dumps data to stdout for now
1033         - fixed bug in CopyOnWrite mode in Data class, where could allocate
1034                 less buffer than data copied
1035         - added "easy exception" debug output macro
1036         - fixed minor spelling error in protocol.cc
1037         - fixed ModeSelectCommand protocol structure - it is not a parameter
1038                 command, but uses the unknown slots for socket and flag
1039                 data
1040         - removed hardcoded socket numbers from protocol.h
1041         - fixed bug in socket.cc:Open() where packet size was not properly
1042                 saved
1043         - implemented socket::Close()
1044         - fixed sequence number checks, so it is reset properly on socket 0
1045         - added Socket::NextRecord() for multiple record data transfers
1046         - fixed input handling bug in translate.cc
1047 2005/11/11
1048         - added .cvsignore files to project
1049         - added README notes to document the source architecture
1050         - added dbsetup data script, which shows how to get into database
1051                 mode, using the RIM Desktop mode, and open a socket
1052         - added blackberry.{h,cc} class
1053         - added command line parameters to bbtool.cc
1054                 -l = list only
1055                 -p = specify pin of blackberry device
1056         - added blackberry test code in bbtool.cc - debugging the initial
1057                 opening protocol: sockets, modes, etc... see dbsetup for
1058                 results
1059         - added copy-on-write functionality to Data class, so it can be used
1060                 with plain data buffers with little performance impact
1061         - added eout() and ddout() debugging - to separate:
1062                 - regular debug output
1063                 - exception debug output (should probably be logged to
1064                         syslog someday, and never turned off)
1065                 - raw data dump output
1066         - changed errno SBError exception handler to try to decode the error
1067                 numbers into english (limited success)
1068         - fixed probe and socket USB Bulk message handling, so they don't
1069                 use PollCompletions(), but use IO::Wait() (libusb_io_wait())
1070         - added common packet size checker in protocol.cc
1071         - fixed unpacked protocol packet structs... using gcc's
1072                 __attribute__ ((packed)) ... see protocol.h
1073         - added ModeSelectCommand structure (protocol.h)
1074         - finished Socket::Open() call  (Close() not yet implemented)
1075         - moved Socket::Send/Receive() out of private, as they can be used
1076                 for socket 0 operations.
1077         - cleaned up pointer management with macros:
1078                 MAKE_PACKET()
1079                 COMMAND()
1080                 IS_COMMAND()
1081         - added IO::Wait() and IO::Cancel() to correspond with libusb API
1082         - added datadumping in usbwrap for easy protocol capture
1083         - added preliminary record.{h,cc} classes
1084         - added Contact record parsing, and test code
1085 2005/10/20
1086         - syncberry tree started