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