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