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