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