1 Release: version 0.6 - 2007/02/??
2 ------------------------------------------------------------------------------
4 - added initial btool.1 man page from Ian Darwin
5 - updated man/Makefile.am for new btool.1
7 - applied btool -h help clarification patch from Ian Darwin
9 - reworked exception hierarchy, so applications can handle all
10 Barry related exceptions, including Usb errors, with
11 one base class: Barry::Error
12 - fixed all the ripple changes this caused throughout the codebase
13 - added BadPassword exception
19 - gui/src/BackupWindow.cc (about dialog)
20 - updated doc/ReleaseChecklist.txt
21 - added usb-level breset.cc command line tool
22 - fixed bug in gui/src/tarfile.* for systems where
23 sizeof(int) != sizeof(void*)
24 - TarFile class now uses a plugin style for the compression
25 operations, to allow for threadsafe versions if needed
27 - also fixed leaked file handle bug in open_compressed()
28 - Thanks to Jonathan Hudson for reporting this for 64bit systems
29 - minor signed comparison fixes in the library
30 - added better protocol data dumping code in probe.cc
31 - added Usb::Device::BulkDrain(), to prevent Barry from hanging
34 Release: version 0.5 - 2007/01/26
35 ------------------------------------------------------------------------------
37 - added missing errno.h header to gui/src/util.cc
38 - lots more endian fixes after testing on iMac
39 - iostream output size fixes
40 - added option to btool to reset the device via software
41 - beefed up exception handling in barrybackup
42 - checked in opensync work-in-progress: trace logging, pointer bugfix
43 this is still experimental
44 - added aboutdialog.* files from gtkmm24 2.10.6, so we have a dialog
45 class for systems running older versions of gtkmm, like
47 - uncommented the about box menu handler
48 - added "cleanall" option to root buildgen.sh script
49 - update ReleaseChecklist.txt
50 - removed CVS auto-history strings from aboutdialog.*
52 - found a link between the unknown field in tagged protocol headers
53 and the unknown field in RecordStateTable entries. This
54 field matters when uploading certain databases, such as
55 Browser Options. It is unknown what this field really
56 means, but we're calling it RecType. Updated the API
57 to use this in all parser objects and builder objects
58 and record objects that use it.
59 - changed some uses of uint64_t to uint32_t, in Contact and
60 Calendar record objects... unique IDs only seem to be
62 - added new static function to record classes: GetDefaultRecType()
63 This returns the default rectype that should work
64 for that record. Ideally this should be retrieved from
65 the device, but in the case where a database has no
66 records, this info would be good to know.
67 - updated convenience template function Controller::AddRecordByType()
68 to use GetDefaultRecType()
69 - documented the recurrance data and how to use it in Calendar objects
70 - added data debug output for incoming USB packets in the
71 socket class... when we ported to the stable libusb
72 we lost some of the verbose output... this should get it
73 back. (In the official release, you need to uncomment
74 ddout() in debug.h for the full blast of debug output).
76 - changed error_done signal into a pure error signal,
77 and changed the logic so the restore continues
78 even if there was a protocol error on one database
79 - changed status bar messages to show what's happening
80 i.e. Backup or Restore
81 - default to not restore the "Handheld Agent" database as
82 it appears to be read-only on the device
83 - added temporary Restore & Backup mode for debugging
84 - added extra hyphen to backup files to show date/time better
85 - updated GUI to save and restore the new RecType field
86 supported now by the library
88 - added future considerations to doc/ReleaseChecklist.txt
89 - applied big endian patch from Jonathan Hudson
91 - removed endian.h include from barry.h, since applications
92 using the library should not care about endianness
93 - hard coded the path to config.h in endian.h
94 so that endian.h never makes it into the final
96 - removed DEFAULT_INCLUDES setting from src/Makefile.am
98 - removed config.h dependency in btool.cc and used library
100 - added big/little endian text to the Barry::Version call
102 - fixed install location of bcharge when building with ./configure;
103 now goes to sbin/ for both source compile and binary packages
104 Thanks to Jonathan Hudson for reporting this bug.
106 - added smarter timeout values to controller, and allowed
107 timeout overrides in the packet, socket, and usbwrap code...
108 extra timeouts are needed for erasing databases for
110 - added an explicit DataDumpParser class to btool.cc, as the
111 library doesn't always have extreme verbose debugging on...
112 this makes sure anyone can always get raw database packets
113 through btool, for development
114 - added thread callback signals for error finishes and erase_db
115 operations, so the GUI is updated properly
116 - more GUI cleanups (status bar updates, etc)
117 - finished implementation of GUI restore
118 - fixed gtkmm/glibmm exception handling when the exceptions
119 occur in sigc signal handlers... in that case,
120 exceptions need to be handled with
121 Glib::add_exception_handler()
122 - added filename-only reading support to TarFile class
123 - added pending gui/TODO items
125 - backup GUI now properly shows progress
126 - the buttons become insensitive when backup is busy
127 - refactored directory check code, and added mkdir check
128 when to the backup setup (so the directory exists
129 when we try to write to it)
130 - updated code to use Barry::Data in new namespace
132 - moved Data class into Barry namespace
134 - updated copyright dates for the new year
135 - clarified exception message in controller.cc
136 - fixed pointer initialization bug in controller.cc
137 - added documentation comments to parser.h and builder.h
138 - updated ReleaseChecklist.txt
140 - changed Barry library configure scripts to make better
141 use of pkg-config for autodetecting dependencies
142 - added initial Barry Backup GUI (gui/ directory), capable of making
143 backups only at this point
145 - added doc/ReleaseChecklist.txt
146 - added version API, returning version number and string
147 - added Troy Engel to AUTHORS
148 - added special case to bcharge.cc for the Blackberry Pearl,
149 which doesn't reset itself after the charge handshake
150 Thanks to Troy Engel for testing.
152 - added pkg-config support for the library (libbarry-0.pc.in)
153 - fixed compile error on g++ 3.3 systems (missing stdint.h
155 - fixed protocol hang at end of Controller operation... in
156 controller destructor, it was deleting the USB interface
157 before closing the socket at the BlackBerry level, thereby
158 leaving he device in Desktop mode
160 - support the newer udev packages on Ubuntu, which need slightly
162 - modified bcharge.cc to search for Pearl devices too.
164 - added Pearl product ID to probe code, but likely not functional
165 yet until we find someone able to get a USB capture for us
167 - version bump in configure.ac and src/Makefile.am
169 Release: version 0.4 - 2006/12/29
170 ------------------------------------------------------------------------------
172 - added bcharge.cc to the tools/ directory (whoohoo!)
173 - added initial release version of rpm/barry.spec (aka bcharge.spec)
174 This begins the barry binary release, currently only
175 including the bcharge utility, but possibly more in
176 the future. Future binary packages will likely include
177 libbarry, libbarry-devel, etc, which barry will then
179 - added udev rule script for BlackBerry devices
180 - added man/ directory and bcharge.1 manpage
181 - added debian/ directory for building deb packages, with initial
183 - added rpm/make-rpm-tarball.sh for building RPMs
184 - split out technical docs into separate libbarry.docs file for
185 a future Debian install
186 - added more cleaning to buildgen.sh
187 - added new udev rule file for Debian stable
188 - hardcoded g++ to 3.3 in debian/rules as I have multiple versions
189 on my system and need to compile releases with stable
191 - ported Barry to use the stable branch of libusb
192 NOTE: no longer depends on the devel libusb tarball!
193 Just use your distro's libusb packages.
194 - fixed more endian issues
195 - minor update to TODO
197 - moved Exceptions, Hacking, and VersionNotes to doc/
198 - added doc/USB-capture.txt
200 - added Controller::AddRecord() and template helper
201 - added beginning version of generic RecordFetch<> template
202 - set default of Barry::Init() to false (no data dump mode)
203 - added examples/ directory, with first addcontact.cc example
205 - added autoconf support based on Peter McAlpine's patch
206 - renamed Makefiles to Makefile.orig and added script to turn
207 on old build system if wanted
208 - fixed boost-specific error path in btool
209 - moved platform specific code out of time.h and into time.cc
210 - moved btool.cc, translate.cc, and upldif.cc out of src/ and
211 into their own tools/ subdirectory
212 - added NEWS file to make autotools happy
213 - added a "clean" option to the buildgen.sh script... maintainer's
215 - reworked autoconf and automake files, to support
216 barry as a library, to move the programs into their
217 own tools directory, and support a proper installation
218 - fixed headers in parser.h, btool.cc, and upldif.cc to work
219 properly when installed standalone
220 - added tools/Makefile.plain for testing compiling against
221 installed barry library
222 - added commentary on version number system
223 - removed Makefile.conf and Makefile.orig, as new autoconf
225 - added support for boost serialization library in autoconf build
226 - added library version number to autoconf build
227 - changed boost flag to __BARRY_BOOST_MODE__ to avoid collisions
228 - removed debug.h dependency from btool.cc
229 - removed libusb check in favour of specific --with-libusb
230 option... may need to revisit this later
231 - quick installation update in README
233 - fixed some missed endian conversions in record.cc and added
235 - fixed endian issues in time.h
236 - added 2 more functions to the time zone API, and adjusted
237 the time zone table for better defaults in North America
238 - added btool and upldif to the make install sequence
239 - added support for Calendar recurrance data
240 - small doc/TimeZones.txt update
242 - added BlackBerry time zone code list, reverse engineered from a 7750
243 - added GetTimeZone() to convert device time zone codes to useful data
245 Release: version 0.0.3 - 2006/11/24
246 ------------------------------------------------------------------------------
248 - added return code check to Controller::SaveDatabase()
249 - fixed Data() class constructor, so it doesn't auto-convert
251 - fixed size checking bug in Packet::ReturnCode() that caused
252 uploading to device to fail
254 - added Exceptions doc file, documenting the C++ exceptions used,
256 - fixed small bug in 'make install' which didn't build first
257 - minor documentation and cleanup in upldif.cc
258 - added utility functions to the RecordStateTable class,
259 GetIndex() and MakeNewRecordId()
260 - changed btool so that the -d command modifiers can be
261 specified multiple times to work with multiple records
263 - added Calendar sync code to the opensync module (not complete)
264 - cleaned up exception handling in the opensync module, making
265 more use of the base exception to make sure no
266 exceptions leak into the C library code
268 Release: version 0.0.2 - 2006/10/12
269 ------------------------------------------------------------------------------
271 - fixed casting error in opensync module
272 - minor updates to documentation to prepare for release
274 - added stdint.h to parser.h for uint32_t. Thanks Ron Gage for
277 - large refactoring of the packet parsing and building code,
278 splitting the code into 3 groups:
279 - record: handles record specific parsing and building...
280 this is mostly subfields with CommonField structs
281 as their headers, but sometimes has a specific
282 header of its own, in the case of email
283 Note: email's header is as yet undecoded.
284 Record does not know the details of the packet
285 formats, only the formats of its own record data.
286 - packet: handles building of complete command packets
287 and handles parsing of commonly used header values,
288 providing an API for it... packet does not know
289 the record format details, but does know the
290 details of each Database Operation (protocol.h)
292 So far, it seems that there is a real separation
293 of operation formats and record formats, with the
294 record formats being the same even with different
295 database operation codes (GET_RECORDS /
296 OLD_GET_RECORDS), which was not confirmed before.
297 See the header size of the email record after
299 - controller: handles device state, and the management of
300 sockets, commands, and checking for response values.
301 The Controller object does not know the format
302 of either the record or the packet it is sending,
303 but does know the protocol handshake logic used
304 to talk to the device.
305 - implemented SetRecord (SET_RECORD_BY_INDEX)... syncing, here
307 - spelling correction in opensync-plugin/AUTHORS
309 - added sample hotplug scripts
310 - added .cvsignore files for doxygen and opensync directories
311 - added src/endian.h... still need to add configure support to
312 handle non-little-endian machines
313 - added exception handler in opensync plugin commit_change()
314 - removed the device reset code in probe.cc, as resetting a device
315 can renumber the devices in /proc on kernel 2.4.x,
316 and cause a failure to reach the device...
317 FIXME - this should be changed someday to reset if probing
318 fails, and restart the probe on reset, as sometimes
319 the blackberry devices respond differently when not reset
320 Ideally, the probe protocol should be properly reverse
322 - added support for retrieving record state table, which is needed
324 - added support for retrieving, deleting, and clearing the dirty
325 flags of individual blackberry device records
326 - added endian macros throughout the code
328 - added opensync-plugin to root Makefile's clean
329 - updated time conversion calls to match opensync's latest SVN
330 - added opensync_change_set_changetype() (only add for now,
332 - removed slow sync functions for now
334 - added quick "install" makefile target, to src/install by default
335 - added static library target... this is temporary until autoconf
336 stuff is added properly... needed for the opensync plugin
337 - documented in comments that Barry::BError is intended to be
338 the base classes for all exceptions
339 - added first round of implementation of an opensync plugin, based
340 on the example plugin code from the opensync sources
342 - added to Contact record class:
344 - ReadLdif() to load and parse LDAP data
345 - added fragmented send support to Socket class
346 - added Probe::FindActive() to make client programs more streamlined
347 - fixed hex/decimal printing of record counts in btool
348 - added upldif.cc, a utility to take ldapsearch output on stdin
349 and upload it to a blackberry
350 - updated src/.cvsignore
352 - added parsing of service book fields:
354 - old and new unique ID (UID)
356 - old and new description
358 - bes domain / domain
359 - date change in legal.txt
360 - added initial parsing of ServiceBook field 0x09, and calling it
361 ServiceBookConfig for now, for lack of a better name
362 - added parsing for ServiceBook field 0x02 on 72xx Blackberries...
363 seems to be a name or description, but doesn't appear
364 in the device's own GUI... called "Hidden Name" for now
366 - added ServiceBook record class and parser code, based on some
367 of Ron Gage's reverse engineering... code is by Chris Frey
369 - fixed the libusb set_configuration/claim_interface order
370 bug in controller.{h,cc}... already fixed in probe,
371 but not controller. Thanks Ron Gage for finding this.
373 - renamed Changelog to ChangeLog in preparation for autoconf
374 - renamed Todo to TODO in preparation for autoconf
376 - make clean cleans up tests properly now
378 - turned source code browsing on in Doxyfile
379 - added LoadDatabaseByName() and LoadDatabaseByType() template members
380 to the Controller class
381 - new file: controllertmpl.h
382 - documentation fixes in builder.h
383 - added static GetDBName() functions to all record classes, in
384 support of the template Controller functions
385 - fleshed out DatabaseDatabase::GetDBNumber() and GetDBName(),
386 returning errors properly
387 - documented sample btool.cc code better, and added example
388 of Controller template member usage
390 - copyright dates updated for 2006
392 - backed out update to latest libusb DEVEL tree, since it is buggy.
393 Stick with libusb 2005/11/26
395 - added clean target to convenience Makefile
396 - added Boost to list of dependencies in README
397 - fixed minor compile warnings in base64.cc
398 - fixed new USB discovery code, and changed endpoint usage to use
399 it, instead of the READ_ENDPOINT and WRITE_ENDPOINT
400 constants... constants are now removed
401 common.h, controller.cc, probe.cc, probe.h, usbwrap.cc
402 - added ClearHalt() to Usb::Device (usbwrap.cc)
403 - updated usbwrap.h to match latest libusb CVS devel tree
404 - updated README to refer to 2005/12/30 libusb CVS devel tree
405 - added roadmap to Todo list
407 - added convenience Makefile in root directory
408 - added Hacking document
409 - minor touchups to README
410 - added caution warning to README, since this release will support
411 delete / overwrite / upload functionality
412 - minor compile order change in Makefile (speed reasons)
413 - added dynamic endpoint discovery to probe.cc
414 - changed claim_interface/set_configuration() function call order in
415 probe.cc based on feedback on the libusb mailing list
416 - added USB discovery code to usbwrap.{h,cc}
418 - fixed packing bug in new upload header struct
419 - renamed CommonField union from data to u to be consistent
420 - added return_code field to DBAccess struct, for error checking
421 - added response checking during upload: if response is non-zero
422 throw exception in controller.cc
423 - added sorting operators to record parser classes... when writing
424 contact data to the device, it may be important to write
425 group link items last, since they reference other contacts...
426 This needs to be tested, and if not required, removed.
427 - added GROUP_FLAG field code to Contact parser class
428 - fixed offset bug in Contact and Calendar Build() functions
429 - fixed name bug in Contact::Build(), now output only with data
430 - added appointment type flag support to Calendar record parser
431 class, and "all day event" flag support
433 - added autoconf to Todo list
434 - refactored the protocol structures so that record structs can
435 be reused for upload and download
436 - with new protostructs, more header control is handled by
437 controller.cc instead of record.cc parsers and builders
438 - parser code now accepts an offset, to govern start of record data
439 - changed Data sizes from int to size_t and removed casts
440 - removed unneeded Parser::GetHeaderSize() (new protostructs make
442 - added Calendar::Build() for calendar uploads
444 - added s11n-boost.h serialization templates for boost::serialization
445 - added boost::serialization to build
446 - minor change in usbwrap.cc to display error codes in decimal
447 - added SizePacket special case code to Socket::Send()... this is
448 required when uploaded packet size is a multiple of 0x40,
449 a special 3 byte size packet is sent
450 - moved some record class variables to public: so they can be
452 - fixed variable name but in RecordBuilder template
453 - added -f switch to btool, for saving and loading of record data
454 - added -s switch to btool, for uploading saved data back to handheld
455 - added Controller::SaveDatabase()
457 - fixed potential casting / pointer bug in controller.cc
458 - added builder.h, to support uploading
459 - minor comment fixes in parser.h
460 - added preliminary Contact protocol record building support
461 - fixed field order bug in ContactRecord protocol struct
462 - Contact record.h class now saves unknown Group Link field,
465 - added -fno-strict-aliasing to compiler flags so gcc-4.0.x won't
466 optimize away protocol struct casts
468 http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25235
469 http://mail-index.netbsd.org/tech-kern/2003/08/11/0001.html
470 http://groups.google.ca/group/comp.lang.c++.moderated/ \
471 browse_thread/thread/e7bf096832526f8e/5714701b \
472 02a2a3cc?hl=en#5714701b02a2a3cc
473 - changed headers so that any low level protocol-specific sizes and
474 structs are completely hidden in the library...
475 this adds library-only header: protostructs.h
477 Release: version 0.0.1 - 2005/11/25
478 ------------------------------------------------------------------------------
480 - added barry.h for documentation purposes and application usage
481 - updated README for release
482 - renamed SBError exception class to BError
483 - updated Doxyfile to version 1.4.5
484 - added more doxygen comments
486 - added conversion routines (and tests) between time_t and min1900_t
487 - added -v option to btool to dynamically control protocol dumping
488 - removed duplicated database database table display in controller.cc
489 - minor spelling corrections
490 - added copyright to usbwrap.{h,cc} as per earlier meeting
491 - added support for Old protocol Calendar entries
493 - added legal.txt, to save typing when adding new source files
494 - ignore test-base64 file (cvsignore)
495 - added contact-to-ldif generation, and updated supporting code
496 - added argument to btool to support contact-to-ldif operation
497 - added Contact::GetPostalAddress()
498 - added README documentation in preparation for future release
500 - added parser.{h,cc} virtual wrapper to generalize LoadDatabase()
501 - added code to socket.cc's Packet() command to re-receive on
502 reception of empty packets... this seems to be a signal
503 from the device that it needs more time for long transfers
504 Current limit: 10 blank packets before exception is thrown
505 Observed maximum blank count: 1
506 - added MessageRecord and OldMessageRecord to protocol.h
507 - changed common record field structs to one CommonField struct
508 - increased default USB timeout to 10 seconds (some loaded devices
509 seem to need more time...)
510 - reorganized record.{h,cc} to try to reduce the code duplication
511 - record.h classes now "know" the sizes of their corresponding
512 protocol structs... this may cause trouble down the line
513 with Python, if used(?)
514 - added Message class for Email records
515 - removed the "Get*" database functions and replaced with
516 general LoadDatabase() call, which loads any database
517 available, and parses it with a Parser object
518 - added GetDBID() for searching for database numbers via name
519 - added test code to retrieve and display all email
520 - cleaned up comments
521 - renamed blackberry.{h,cc} to controller.{h,cc}
522 - renamed bbtool.cc to btool.cc
523 - added Makefile.conf
524 - added copyright notices to source files
525 - added COPYING file with GPL
526 - put parser in Barry namespace, and added auto_ptr-like mode for
527 store object pointers
529 - added header comments to convo.awk script
530 - removed Test() function in Controller object, and made class
531 better suited to its general API purpose
532 - changed OpenMode() so it loads command table and DBDB... it is now
533 a public API function
534 - moved Controller test code to btool.cc and made tool more
535 generically useful... can now download any DB by name on
537 - added mode checks to Controller
538 - added -t and -d command line options to btool
539 - added base64 routines from John Walker / Fourmilab and Citadel/UX
540 - converted base64 routines into an API, instead of hardcoded
543 - changed project name to Barry, including namespaces
544 - renamed sbcommon.* to common.*
545 - increased USB default timeout to 2 seconds
546 - fixed formatting bug in Data operator<< output
547 - cleaned up the protocol packet structs, getting rid of the
548 confusing param/simple split... param is now the tableCmd
549 from the Command Table
550 - moved protocol structs from record.h to protocol.h
551 - added support for older version of the USB protocol, which matches
552 the Cassis spec more closely
553 - fixed the hardcoded offsets in blackberry.cc's protocol parsing
554 - fixed Socket::Close() so on error, socket flags are reset.
555 This stops Close() from being called twice on exception
558 - added Doxyfile to the project
560 - added mode selection support to Blackberry class (RIM Desktop,
561 RIM Bypass, and RIM_JavaLoader)
562 Mode selection governs which socket is used in subsequent
564 - added Command Table parsing and protocol support
565 Blackberry class, and CommandTable record class
566 - added Database database parsing and protocol support
567 Blackberry class and DatabaseDatabase record class
568 - added Address book retrieval support - dumps data to stdout for now
569 - fixed bug in CopyOnWrite mode in Data class, where could allocate
570 less buffer than data copied
571 - added "easy exception" debug output macro
572 - fixed minor spelling error in protocol.cc
573 - fixed ModeSelectCommand protocol structure - it is not a parameter
574 command, but uses the unknown slots for socket and flag
576 - removed hardcoded socket numbers from protocol.h
577 - fixed bug in socket.cc:Open() where packet size was not properly
579 - implemented socket::Close()
580 - fixed sequence number checks, so it is reset properly on socket 0
581 - added Socket::NextRecord() for multiple record data transfers
582 - fixed input handling bug in translate.cc
584 - added .cvsignore files to project
585 - added README notes to document the source architecture
586 - added dbsetup data script, which shows how to get into database
587 mode, using the RIM Desktop mode, and open a socket
588 - added blackberry.{h,cc} class
589 - added command line parameters to bbtool.cc
591 -p = specify pin of blackberry device
592 - added blackberry test code in bbtool.cc - debugging the initial
593 opening protocol: sockets, modes, etc... see dbsetup for
595 - added copy-on-write functionality to Data class, so it can be used
596 with plain data buffers with little performance impact
597 - added eout() and ddout() debugging - to separate:
598 - regular debug output
599 - exception debug output (should probably be logged to
600 syslog someday, and never turned off)
601 - raw data dump output
602 - changed errno SBError exception handler to try to decode the error
603 numbers into english (limited success)
604 - fixed probe and socket USB Bulk message handling, so they don't
605 use PollCompletions(), but use IO::Wait() (libusb_io_wait())
606 - added common packet size checker in protocol.cc
607 - fixed unpacked protocol packet structs... using gcc's
608 __attribute__ ((packed)) ... see protocol.h
609 - added ModeSelectCommand structure (protocol.h)
610 - finished Socket::Open() call (Close() not yet implemented)
611 - moved Socket::Send/Receive() out of private, as they can be used
612 for socket 0 operations.
613 - cleaned up pointer management with macros:
617 - added IO::Wait() and IO::Cancel() to correspond with libusb API
618 - added datadumping in usbwrap for easy protocol capture
619 - added preliminary record.{h,cc} classes
620 - added Contact record parsing, and test code
622 - syncberry tree started