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