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