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