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