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