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