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