- fixed locale issues in src/data.cc
[barry.git] / ChangeLog
blobbfe6cc70563ae65966fa06c180542a0083165395
1 Release: version 0.12 - 2008/02/??
2 ------------------------------------------------------------------------------
3 2008/01/25
4         - fixed locale issues in src/data.cc
5 2007/12/21
6         - applied wording correction patch to btool from Matt LaPlante
7 2007/12/07
8         - changed hard coded databases names in btool to calls to
9                 <recordclass>::GetDBName()
10         - version bump:
11                 - configure.ac
12                 - src/Makefile.am
13                 - src/version.cc
14                 - gui/src/BackupWindow.cc
15                 - src/Doxygen
16                 - rpm/barry.spec
17                 - debian/changelog
18                 - opensync-plugin/src/barry_sync.cc
19         - updated TODO
21 Release: version 0.11 - 2007/12/01
22 ------------------------------------------------------------------------------
23 2007/12/01
24         - fixed null pointer bug in Probe class (bug #1842407)
25         - added pause to maintainer release script
26 2007/11/30
27         - version bump:
28                 - configure.ac
29                 - src/Makefile.am
30                 - src/version.cc
31                 - gui/src/BackupWindow.cc
32                 - src/Doxygen
33                 - rpm/barry.spec
34                 - debian/changelog
35                 - opensync-plugin/src/barry_sync.cc
37 Release: version 0.10 - 2007/11/30
38 ------------------------------------------------------------------------------
39 2007/11/30
40         - added support to the usbwrap Match class to limit its
41                 search by busname / devname
42         - added support to the Probe class to limit its search for
43                 Blackberry devices to a given bus or device name
44         - added command line options to btool for the above Probe
45                 bus/device names, and updated the man page
46         - updated the www docs with regard to the new usb_storage
47                 behaviour and the new blacklist files... less
48                 concern about berry_charge and usb_storage conflicts
49         - added bidentify tool and accompanying man page
50         - fixed bug in rpm maintenance script that used the wrong
51                 spec file for opensuse
52 2007/11/29
53         - added better error checking to breset
54         - commented the sleep() for the 8830
55         - added code to handle the race condition where usb_storage
56                 claims the device before bcharge arrives on the scene,
57                 by asking the kernel to detach the driver from
58                 the Mass Storage interface... this change makes it
59                 possible to run bcharge, moving from 0006 to 0004
60                 to 0001 and back to 0004, all *while* usb_storage
61                 is loaded!
62         - changed Probe class behaviour so that it will not throw an
63                 exception on Device Busy (-EBUSY) but instead
64                 log the error in an internal array and keep going.
65                 This makes it possible to use btool and barrybackup
66                 with two devices plugged in at the same time.
67                 BACKWARD COMPATIBILITY NOTE: this changes initializaion
68                         behaviour, but in practice, it should only
69                         make applications look more capable, not less.
70         - updated btool to show errors logged by Probe
71         - added message to specify which PIN device is being used by btool
72         - added explanatory comments to udev rules files, about why
73                 they are so verbose
74 2007/11/27
75         - added ClearHalt() calls to probe and controller classes, just
76                 before any communication happens... the 8830 seems
77                 to need this
78 2007/11/23
79         - added usbwrap.cc:GetConfiguration()
80         - added code to check whether the configuration is the one
81                 we require, before calling SetConfiguration()... and not
82                 to call it if unnecessary.  This allows us to run
83                 at the same time as usb_storage.
84                 Thanks to Martin Owens for not letting this issue go. :-)
85         - added sleep to bcharge, before calling usb_reset()... the
86                 Blackberry 8830 behaves like a Pearl device in that
87                 it has mass storage support, but behaves like a Classic
88                 in that it resets itself... the usb_reset() seems
89                 to reset it back to 0006.  The sleep allows the device
90                 to disappear via its own reset, and let usb_reset()
91                 fail naturally on these devices.
92                 This is not an ideal solution... mainly for testing.
93 2007/11/09
94         - added modprobe/blacklist-berry_charge as per Simon Ruggier's
95                 suggestion.  Thanks also to Niels de Vos for a similar
96                 suggestion.
97         - fixed udev rules to work on both old and new distros
98                 Thanks to Duncan Mak for the bug report.
99         - AUTHORS update
100         - fixed string comparison to use case insensitive compare in
101                 opensync plugin
102         - updated Debian package to include modprobe blacklist file
103         - updated rpm spec file to include modprobe blacklist file
104         - split the maintenance scripts into release and test, so
105                 that release package builds can be done faster
106 2007/10/26
107         - opensync plugin fixes:
108                 - fixed memory leak in vBase::GetAttr()
109                 - added support in vformat parser to parse "blocks"
110                         and keep track of the hierarchy when
111                         parsing an iCalendar, etc.
112                 - added support for searching for attributes only
113                         inside certain blocks (i.e. find first
114                         DTSTART in VEVENT block, not VTIMEZONE block)
115 2007/10/25
116         - fixed bug in Calendar::Clear, missing the Free / Class
117                 member variables, leaving them uninitialized
118         - added examples/addcalendar.cc
119         - added more logging to the opensync plugin, logging the
120                 ToBarry conversion results
121         - added code to force struct tm.tm_isdst to -1 before calling
122                 mktime, in vformat.c
123                 - fixed typo in previous fix
124 2007/10/12
125         - renamed ktrans and translate to bktrans and btranslate to avoid
126                 file name clashes with libtranslate of Gnome
127                 Closes bug #1812410 reported by Troy Engel.
128         - version bump:
129                 - configure.ac
130                 - src/Makefile.am
131                 - src/version.cc
132                 - gui/src/BackupWindow.cc
133                 - src/Doxygen
134                 - rpm/barry.spec
135                 - debian/changelog
136                 - opensync-plugin/src/barry_sync.cc
137         - fixed missing default config file in the debian package for
138                 the opensync plugin
139                 Closes bug #1812224 reported by Ariel (adonatti).
140         - added debian dbg packages for tracing segfaults
141         - modified maintainer scripts so debug packages would reference
142                 source code located in /usr/src/barry-0.9, etc.
144 Release: version 0.9 - 2007/10/12
145 ------------------------------------------------------------------------------
146 2007/09/29
147         - adjusted autosuspend disabling code in bcharge, based on new
148                 information on how kernels 2.6.21 / 2.6.22 work.
149                 See bcharge.cc for comments.  If device/power/level or
150                 device/power/autosuspend exist, charging should now work
151                 without recompiling the kernel.
152         - updated website docs with autosuspend info
153 2007/09/27
154         - large update to the doc/www web pages, moving some of the
155                 information in README files to html format, so that it
156                 is commonly available on the web
157         - added step in maintenance scripts to automatically build the
158                 .html files in doc/www when making a tarball release
159 2007/09/22
160         - added libopensync 0.22 version requirement to barry.spec file,
161                 but it doesn't seem to work on OpenSuSE 10.2, where it's
162                 needed.... hmmmm
163 2007/09/21
164         - updated README to mention new tree build configure options
165         - fixed the configure scripts and makefiles so that when building
166                 with custom CXXFLAGS and LDFLAGS environment variables,
167                 it doesn't break the full-tree build mode, when
168                 using --enable-gui and/or --enable-opensync-plugin
169         - added config.h.in~ to buildgen.sh clean target
170         - converted Debian build scripts to use cdbs
171         - added opensync plugin binary package for Debian
172         - added "Getting Started" section to web pages, as well as an
173                 explanatory document for various system requirements
174         - turned on opensync build in RPM maintainer scripts
175 2007/09/20
176         - added filename to power/state error message in bcharge.cc
177         - adjusted maintainer scripts to automatically adjust barry.spec
178                 for opensuse rpm builds
179 2007/09/13
180         - fixed some of the release build scripts and added support for
181                 automated opensuse 10.2 builds
182                 - fixed build target to i386
183                 - changed scripts to add to PKG_CONFIG_PATH variable instead
184                         of overwriting it
185 2007/09/07
186         - added website docs to doc/www... these are out of date at the
187                 moment, and hopefully by including them here, they
188                 will be updated more frequently
189 2007/09/05
190         - applied Simon Ruggier's build system patch that allowed a build
191                 of all 3 components from the root directory and fixed the
192                 configure scripts to support external build directories
193         - reordered clean commands in the buildgen.sh scripts, and removed
194                 the INSTALL files, since they are auto-generated by autoconf
195         - removed extraneous buildgen.sh calls in maintainer scripts
196         - added Simon Ruggier to AUTHORS
197         - added explanatory note to 3 stage test build process in
198                 maintainer script
199 2007/08/24
200         - fixed Category handling in the Contact record class, to
201                 parse the comma separated string into an array,
202                 and back
203                 Note: this involves a change to the boost serialization
204                         and will affect backward compatibility with
205                         old serialization datafiles
206         - added Category to examples/addcontact.cc
207         - added Category support to the opensync plugin
208 2007/08/23
209         - fixed wrong read/write in btool output (oops)
210         - added BadSize exception, and changed CheckSize() function
211                 to throw it on error
212         - changed backup GUI to catch BadSize exceptions on initial
213                 connect, and try a reset if that error occurs, since
214                 that likely means the device didn't shutdown properly
215         - fixed in opensync plugin:
216                 - some vcard data contains types codes in capital letters,
217                         so added lower case conversion routine
218                 - changed the order of address lines, so that address1
219                         is the street, address2 is the extended address,
220                         and address3 is the PO Box.  The Blackberry
221                         doesn't seem to have any PO Box field.
222 2007/08/20
223         - added -e endpoint override option to btool
224         - added status message to endpoint override
225 2007/08/18
226         - added configure check for strnlen, and implementation for
227                 systems that don't have it, or that have it implemented
228                 incorrectly.  Went a little paranoid here, since
229                 AC_FUNC_STRNLEN doesn't set a define in config.h,
230                 so I had to do it manually, and check in case autoconf
231                 changes in the future... ugh.  See src/strnlen.h for
232                 the gory details.
233         - added code in probe.cc to fetch the device's description.
234                 The description is now part of the probe results
235                 along with the PIN.  Updates to protocol.h, adding
236                 a new attribute definition.
237                 Thanks to Rick Scott for pointing out the code in
238                 XmBlackberry where he implemented this first.
239         - fixed header dependency in record-internal.h
240         - updated the "required autoconf" version to 2.61 for root build
241         - moved nested structs out of the record classes that contain them,
242                 in order to better support SWIG and Python
243 2007/08/17
244         - changed bcharge to use getopt() for its argument processing
245         - added options -p and -s to bcharge, to adjust usb suspend
246                 settings automatically where possible
247         - updated the udev rules to use the new bcharge settings
248         - updated the bcharge man page with the new arguments
249 2007/08/16
250         - cleaned up Usb exception handling, moving libusb error code
251                 processing into the Usb::Error exception class.
252                 error.cc is now an empty shell
253         - added return codes to the Usb::Error exceptions
254         - removed aboutdialog.{h,cc} from the backup GUI since even
255                 Debian stable now has up-to-date gtkmm libraries
256         - added more user friendly error message for the "device busy"
257                 case, recommending 'rmmod usb_storage'.
258 2007/08/09
259         - added better error checking to bcharge.cc
260         - version bump:
261                 - configure.ac
262                 - src/Makefile.am
263                 - src/version.cc
264                 - gui/src/BackupWindow.cc
265                 - src/Doxygen
266                 - rpm/barry.spec
267                 - debian/changelog
268                 - opensync-plugin/src/barry_sync.cc
269         - removed usb_set_configuration() check from bcharge.cc, since
270                 that may fail under normal operation, in this case
272 Release: version 0.8 - 2007/08/03
273 ------------------------------------------------------------------------------
274 2007/08/03
275         - moved Interface implementation to usbwrap.cc file
276         - added dout debugging messages to usbwrap.cc
277         - clarified unhandled packet error message in socket.cc
278         - added temporary workaround in opensync-plugin environment's
279                 Reconnect(), for odd message seen on newer Blackberry
280                 devices
281         - fixing issues with Brian Edginton's MessageRecord patch (2007/06/29)
282                 - fixed missing size check in message oriented ParseHeader()
283                 - fixed endian conversion issues (also found one pre-existing
284                         endian bug in the process)
285                 - moved message timestamp converter code to time.cc
286         - added Barry version number to opensync plugin name
287         - changed maintainer scripts and rpm.spec to use bzip2 instead of gzip
288         - added opensync-plugin to configure script build
289         - added -S option to btool, to list supported parsers and builders
290         - slight change to opensync-plugin/buildgen.sh to cleanup config.h.in~
291         - opensync-plugin/README update
292         - added opensync-plugin/patches for others who may be building and
293                 testing the plugin with OpenSync 0.22
294         - added debian package build scripts to maintainer/
295 2007/08/01
296         - added entry to doc/TroubleShooting.txt
297 2007/07/28
298         - added doc/TroubleShooting.txt
299 2007/07/27
300         - opensync plugin:
301                 - fixed bug in vcard.cc that was using the FN field
302                         for the broken-down name instead of N
303                 - added dbId and dbName to DatabaseSyncState
304                 - added Reconnect() functionality to BarryEnvironment class
305                         and moved connect logic out of barry_sync.cc
306                 - changed the batch commit functionality in barry_sync.cc
307                         to single-change-commit.  Why?  Because opensync
308                         0.22 groups all batch changes into one group
309                         and calls one batch commit function, even if you
310                         registered two.  Moving to single change commit
311                         mode removes a chunk of unneccessary code
312                         from the plugin as well, and can in theory
313                         ease memory pressure in the library.
314                 - added FinishSync() to perform actions needed on successful
315                         syncing completion
316                 - disconnect on successful sync completion, and reconnect,
317                         since the device's dirty flags don't seem to
318                         be updated until a disconnect occurs.
319 2007/07/26
320         - added ReadDataArray() to data.h, using an istream instead of
321                 requiring a file
322         - added raw data version of BuildField() to record-internal.h
323                 This is so that btool doesn't add extra null terminators
324                 to unknown data, when restoring with option -s
325         - fixed bugs in r_contact.cc:
326                 - fixed bug that caused a LastName/FirstName swap
327                         if FirstName was empty and you wrote a contact
328                         record into the device.... First/Last Name
329                         fields are position sensitive, and the code
330                         was missing the empty FirstName case on writing
331                 - fixed bug in BuildFields() and Dump() where they
332                         were not updated to handle the new field
333                         table added for the postal address changes
334                         on 2007/07/20, oops
335         - opensync plugin:
336                 - changed the plugin config file, so it is possible to
337                         turn debug output on/off without recompiling
338                 - moved the standalone Map2Uid() function into
339                         the DatabaseSyncState class, and changed the
340                         code to produce "contact-#" and "calendar-#"
341                         UID strings, instead of just numbers
342                 - changed default PIN to -1, so that if the user doesn't
343                         configure properly, it will fail... this is a
344                         safety measure to avoid syncing with different
345                         devices and corrupting the cache/idmap...
346                         this should be fixed someday, to handle this
347                         automatically
348                         On second thought... is this right?  Perhaps
349                         it is better to fail if the PIN is not what
350                         is expected, so a user doesn't accidentally
351                         sync the wrong device and lose data.
352                         Actions to take on new PIN:
353                                 - force slow_sync, or
354                                 - fail
355                 - incorporated the new VCardConverter code into the
356                         main barry_sync.cc plugin code
357                 - fixed bug that did not clear the devices dirty flags
358                         in the case where a sync only read data from it,
359                         and didn't write
360                 - changed PIN error message number to hex
361 2007/07/20
362         - minor wording change in backup GUI prompt: "Backup working..." to
363                 "Backup in progress..."
364         - renamed Contact class's Title field to JobTitle for clarity
365         - added record function ParseFieldString(), which properly handles
366                 strings from the device that have multiple null terminators,
367                 and changed the record parsing code to use this new function
368         - moved FullName() function from ldif.cc to r_contact.cc since it
369                 is generally useful in areas outside of LDIF processing
370         - refactored postal addresses in the Contact record class into
371                 a new class called PostalAddress
372         - renamed Address class in record.h to EmailAddress
373         - moved Contact::GetPostalAddress() to record.cc as part of the
374                 new PostalAddress class and renamed it
375                 PostalAddress::GetLabel()
376         - opensync plugin:
377                 - refactored vformat helpers into separate base class
378                         called vBase
379                 - added vCard converter class
380                 - commented out the code that skipped over the adding
381                         of empty attribute values and parameters,
382                         since VCARD depends on some of this behaviour
383                 - movified vformat.c:vformat_find_attribute() to take
384                         an extra nth argument, in order to search
385                         for multiple attributes with the same name...
386                         the way this is coded is a bit inefficient...
387                         but we're moving away from vformat when we move
388                         to OpenSync 0.3x / 0.40, so this is just temporary
389                         pain
390 2007/07/19
391         - added SUBSYSTEM=="usb_device" to example udev rules, in order
392                 to avoid running bcharge for each endpoint that is
393                 added by udev, when first plugged in.  Running bcharge
394                 back-to-back multiple times can crash some
395                 Blackberries.
396 2007/07/14
397         - opensync plugin:
398                 - fixed ID mapping bug in the case of a non-numeric UID
399                         from syncing external -> Barry, and then the
400                         new Barry ID would look like a new change
401                         when syncing back from Barry -> external.
402                 - added support for slow sync
403                 - added clear() to idmap class
404                 - added vformat attr parameter extraction class
405                 - added more trace logging during vformat/Barry conversions
406                 - added Notification time support
407                 - handled "all day" vformat special case, when DTEND
408                         does not exist in a vformat data block
409         - changed the min1900_t time conversion functions to handle
410                 the 0xffffffff special case, when notifications
411                 are turned off on a calendar event (src/time.cc)
412         - also made the calendar data dump output clearer for
413                 disabled timestamps, and added debug output
414                 for the raw min1900 value, in case there are more
415                 special cases in the future
416 2007/07/13
417         - fixed null pointer access in opensync's HasMultipleVEvents()
418 2007/07/12
419         - upper management directive: revert all OpenSync 0.3x changes
420                 and proceed with OpenSync 0.22.  Reverting the
421                 opensync-plugin/src tree to Barry 0.7 status.
422 2007/07/06
423         - reorganized exception and trace code in opensync plugin
424         - added XmlToCalendar() function, based on unfinished opensync
425                 library API that is not yet finished... will be
426                 committed to opensync svn tree when complete
427         - added OSyncXMLField logger to plugin trace class
428 2007/06/29
429         - applied email MessageRecord patch from Brian Edginton (thanks!)
430         - updated Message::Dump() to output more valid mbox data...
431                 the goal is to be able to do:
432                         btool -d "Messages" > email.mbox
433                         mutt -f email.mbox
434         - changed some TODO's to FIXME's to keep it grep-consistent
435         - applied Folder support patch from Brian Edginton
436         - fixed pedantic compile warnings, and changed order in src/Makefile.am
437         - removed unneeded cast in src/r_folder.cc
438 2007/06/28
439         - minor adjustment to ctags building in buildgen.sh
440         - applied patch from Brian Edginton for better boost detection
441                 in configure.ac
442         - added boost usage message to btool -h output
443 2007/06/21
444         - more porting of OpenSync module to 0.30
445         - added ctags build for opensync source tree to buildgen.sh
446 2007/06/14
447         - changed PKG_CONFIG_PATH setting in rpm script, so that systems
448                 like SuSE that have an extensive PKG_CONFIG_PATH
449                 in general use will not break on build
450         - added PKG_CONFIG_PATH to debian script too, just in case :-)
451         - added debian/changelog to doc/ReleaseChecklist.txt
452         - added comment to rpm/barry.spec regarding SuSE RPM builds
453 2007/06/08
454         - applied patch from Niels de Vos fixing debian package build
455                 dependency
456         - applied Brian Edginton's Saved Email Messages patch
457         - updated r_saved_messages.cc comment to match header
458         - added GetRecType()/GetUniqueId() to r_saved_messages.h, since
459                 SetIds() is already there
460         - removed Address version of operator<<() from message related headers
461                 and moved into record.h
462         - added std::hex to message related dumps, and changed output to
463                 be more mbox-like
464         - updated doc/CodingStyle.txt to cover switch() statements
465         - opensync compiles again, with 0.30!  (not functional yet)
466                 - moving closer to more modular and reusable plugin functions
467         - updated release checklist for opensync version number
468 2007/06/07
469         - added doc/CodingStyle.txt... preliminary version
470 2007/06/06
471         - applied Brian Edginton's PIN message patch
472         - changes to PIN message patch:
473                 - fixed missing backslash in src/Makefile.am
474                 - fixed tab alignment throughout
475                 - removed typedef from Address struct
476                 - added clear() to Address... might as well, if it it is
477                         going to be a standalone type
478                 - fixed missing comma in PINMessageFieldLinks table
479                 - changed MessageRecordId in PINMessage to load from a new
480                         uint32_t field in CommonField, instead of piggy
481                         backing on a field for other use
482         - did some testing and found that PINMessage's MessageRecordId
483                 is the same as the RecordId given through the SetIds()
484                 API... but these Id's are duplicated in the protocol...
485                 RecordId is stored in the protocol header, while
486                 MessageRecordId is stored in the record it self as
487                 a common field... added RecType and RecordId to
488                 PIN Message so that we store both of these
489         - updated AUTHORS
490 2007/05/27
491         - added item to gui/TODO
492         - applied Brian Edginton's s11n-boost.h patch
493 2007/05/25
494         - renamed template values to more consistent naming scheme
495         - applied memos and tasks patch from Brian Edginton, slightly
496                 modified to split into the new separate files system
497         - changes to memos and tasks classes:
498                 - reformatted the code to match coding style
499                         (come on Brian) :-)
500                 - added copyright notice
501                 - changed class to singular (Memo, not Memos)
502                 - placed in Barry namespace
503                 - added #ifdef header protectors
504                 - added new files to Makefile.am
505                 - added new r_*.h headers to record.h
506         - added support for Memos and Tasks to tools/btool.cc, based on
507                 Brian Edginton's patch
508                 (currently commented out, for Boost library reasons):
509         - added doc/CommitPolicy.txt
510         - updated AUTHORS
511 2007/05/24
512         - added ctags generation to buildgen.sh
513         - applied record.{h,cc} fix patch from Brian Edginton
514                 - ClassFlag
515                 - FreeBusyFlag
516                 - Clear() fixes
517         - fixed broken formatting in above patch
518         - refactored record parser classes into separate files for each
519         - changed the ConvertHtoB<> template to inline, as it caused
520                 linker errors with the new file layout
521 2007/05/17
522         - fixed bug in Debian packaging that put util commands in
523                 /bin and /sbin instead of /usr/bin and /usr/sbin
524         - commited byteswap.h replacement code from gm2net
525         - backup gui:
526                 - removed unneeded debug messages on stdout
527                 - changed the default for debug output to "off"
528                         and added a command line option to turn
529                         it on if necessary  (--debug-output)
530                 - command line option --help now also works
531         - fixed bug in Calendar class where it didn't initialize
532                 RecType properly... and cleaned up other RecType
533                 code to use the GetDefaultRecType() functions,
534                 localizing the constants in one place
535 2007/05/11
536         - applied patches from Brian Edginton, parsing more
537                 fields in Contact and Calendar records
538         - added Brian Edginton to AUTHORS
539         - reformatted record.{h,cc} to match the rest of the code,
540                 removed commented out code, and removed mention of
541                 Outlook from the comments.
542         - updated udev/10-blackberry.rules.Debian for Debian Etch
543         - updated debian/rules to use new udev rules file
544         - removed debian/postinst, as stable versions of Debian now
545                 have a recent udev, and don't need the special handling
546         - updated Debian build scripts to build separate packages:
547                 libbarry
548                 libbarry-dev
549                 barry-util
550                 barrybackup-gui
551         - added menu support to Debian barrybackup-gui package
552         - made the buttons bigger in the backup GUI, as they were too
553                 small on Debian Etch
554         - opensync plugin:
555                 - more progress in porting to opensync 0.30, heavily
556                         based on the example plugin in the opensync
557                         svn tree...  this is a work in progress, and so far
558                         is incomplete
559 2007/05/04
560         - opensync plugin:
561                 - partial porting to opensync 0.30 (in progress!)
562                 - fixed bug in sync_done where it reported context error
563                         and then success afterward
564         - checking in new INSTALL files based on Etch's autoconf run
565         - added item to gui's todo list
566         - bumped version numbers to 0.8 in:
567                 - configure.ac
568                 - src/Makefile.am
569                 - src/version.cc
570                 - gui/src/BackupWindow.cc (about dialog)
571                 - src/Doxygen
572                 - rpm/barry*.spec
574 Release: version 0.7 - 2007/05/02
575 ------------------------------------------------------------------------------
576 2007/05/02
577         - added rpm building to maintainer/release scripts
578         - added "HEAD" feature to tarball creation script, for easier testing
579         - updated maintainer/README
580         - updated maintainer/release.sh to use new HEAD feature too
581 2007/05/01
582         - added pppob to rpm barry.spec
583         - bumped release number in barry.spec
584 2007/04/30
585         - opensync plugin:
586                 - fixed size check bugs (strlen() == 0 when empty)
587                 - finished refactoring calendar conversion routines
588                 - started timezone parsing, but this may go away
589                         if we use opensync 0.30's time functions and
590                         xml data format...
591                 - added development note to README
592 2007/04/29
593         - updated README and opensync-plugin/README with more current
594                 build instructions
595         - opensync plugin:
596                 - refactored some calendar conversion routines
597                 - added Barry->vCalendar conversion for recurring appointments
598 2007/04/27
599         - opensync module:
600                 - removed some unneeded trace logs
601                 - fixed VEventConverter constructor bug, with uninitialized
602                         m_Data pointer
603                 - eased up the requirement that every calendar event
604                         must have a summary... defaults to "<blank subject>"
605                         if empty
606                 - added more VCALENDAR fields to match Barry::Calendar record
607                 - fixed case sensitive compares in vformat.c
608 2007/04/26
609         - opensync module work:
610                 - added id map class to map string uid's from OpenSync to
611                         numeric ID's from the Blackberry
612                 - fixed bug in CommitChange() where it was still using
613                         a hard coded calendar record state table
614                 - added lots of logging throughout
615                 - fixed bug where newly added records didn't use the
616                         change object's uid, but created a new ID,
617                         causing another sync on the next run
618                         i.e. (CommitData_t was missing an argument)
619                 - fixed bug where uninitialized notification time was
620                         written to the Blackberry
621         - more opensync module work:
622                 - refactored the environment class into another subclass
623                         called DatabaseSyncState, and moved some stand-
624                         alone functions from barry_sync.cc into
625                         the environment classes
626                 - added a tagged constructor to the trace class
627                 - fixed idmap::Load() to clear map before loading
628 2007/04/20
629         - renamed barry-config to barry-sync, the default configuration
630                 file for the opensync module... and filled it with
631                 a sample configuration
632         - added code to update the calendar cache, and write it to disk
633                 on success (opensync module)
634         - added code to clear dirty flags in the device (opensync module)
635         - allowed comments in the config file
636         - added vformat.c from libopensync 0.22, since the vformat
637                 routines are not available from the plugin side
638 2007/04/19
639         - updated gui/TODO
640         - added -d switch to bcharge to switch back from 0001 to 0004 mode,
641                 changed the auto-detection logic to ignore iProduct and
642                 only use idProduct, and updated man page
643         - updated breset to recognize the Pearl in 00004 mode as well
644         - changed src/probe.cc logic to assume that the second endpoint
645                 pair is the one needed for database communication, instead
646                 of doing a reverse search from the end... newer Pearls
647                 in Dual mode seem to have at least 3 or 4 endpoint pairs,
648                 and the old search didn't always work
649         - applied sourceforge patch #1696884 from Peter Silva, updating
650                 the Debian build for Etch, and including all files in one deb
651         - added Peter Silva to AUTHORS file
652         - uncommented the "make distclean" in debian/rules, and removed
653                 the reliance on /tmp when installing 99-barry-perms.rules
654         - applied bb_task_format.txt patch from Peter Silva
655         - fixed each misspelling of "recurrance" to "recurrence"
656         - tweaked src/probe.cc again for paranoia's sake... start at
657                 offset 1 if more than 1 endpoint pair, otherwise start
658                 search at 0
659         - split up opensync module into multiple source files, and started
660                 using the opensync vformat routines for parsing and building
661                 the vevent20 data (experimental)
662 2007/04/04
663         - more incremental work on the opensync plugin, adding ADDED
664                 and MODIFIED functionality... (experimental!)
665 2007/03/30
666         - added code to dump extra descriptors during device discovery,
667                 if found
668         - bumped opensync version number in configure.ac, and made
669                 the configure scripts more consistent with the rest
670                 of the project
671         - fixed printf-format size bug in opensync module
672 2007/03/29
673         - applied patch from Niels de Vos, fixing deb udev rules for Pearl
674         - updated AUTHORS
675         - fixed extra space bug in LDIF output (added space when creating
676                 FullName, even if there was no last name)
677         - fixed Address Book record parsing in Contact class... the
678                 Blackberry database uses field id 0x20 for both the
679                 first and last names, and if only a last name exists,
680                 the first name will be empty.  Fixed parser to handle
681                 this special case, without relying on string length.
682                 Thanks to Troy Engel for reporting above two LDIF bugs.
683         - added a few more constants to bcharge.cc
684         - renamed opensync's configure.in to configure.ac
685 2007/03/17
686         - fixed bcharge to avoid endless reset loop... oops
687 2007/03/16
688         - reorganized bcharge.cc to make it possible to switch between
689                 Pearl modes 0004 and 0001
690         - added flag to BadPassword exception class, to signal whether
691                 the library considers the device "out of retries" or not
692         - updated socket.cc for new BadPassword exception
693         - added special case to Controller class destructor to reset the
694                 device if being destroyed in a half-open state... this is
695                 a temporary fix until we understand how to handle
696                 the "already open" message we get when opening the Desktop
697                 in some cases
698         - added password prompt dialog to the backup GUI
699         - fixed possible memory leak in GUI's DeviceInterface::Connect()
700 2007/03/08
701         - committed Troy Engel's bbrules_mass_symlinks.patch, fixing
702                 udev rules for the Pearl
703         - updated 10-blackberry.rules.Debian to match 10-blackberry.rules's
704                 functionality
705         - applied Troy Engel's barry.spec patch to generate all required
706                 RPM's... Thank you!  Notes in the README taken from
707                 the sourceforge tracker entry containing the patch.
708         - added libusb lib flags to tools/ and examples/ makefiles,
709                 and tweaked configure.ac with a better default,
710                 to build cleanly on RHEL 4
711         - modified rpm/barry.spec:
712                 - does not create doc-only barry base package anymore
713                 - fixed "barry-backup" typo
714                 - removed the patch step, as version 0.7 shouldn't need it
715                 - added license file to each package
716                 - commented out console perms scripts, pending mailing list
717                         discussion
718         - updated AUTHORS
719         - applied Troy Engel's barry.spec patch to fix RHEL4 compile issues
720         - fixed 80 column wrapping error in barry.spec, thanks to Troy Engel
721                 for the bug report
722         - applied Troy Engel's udev permissions patch for Redhat/Fedora
723                 systems, which automatically set the ownership of a
724                 newly plugged in device to the currently logged in console
725                 user.
726         - added udev/README to document what all those files are for...
727                 part of the text comes from the sourceforge comment
728                 on the above udev permissions patch from Troy Engel
729         - uncommented the console perms scripts for rpm/barry.spec
730         - added libglademm-2.4 to gui/README's dependency list
731         - made usbwrap.* calls more threadsafe
732         - added Usb::Timeout exception for timeout errors
733         - added preliminary UsbSerData support to library for GPRS modem
734                 functionality, using Rick Scott's XmBlackBerry's serdata.c
735                 as a guide
736         - added overloaded Socket::Send() for sending without receiving
737         - added preliminary pppob command line tool
738 2007/03/02
739         - version bump in:
740                 - configure.ac
741                 - src/Makefile.am
742                 - src/version.cc
743                 - gui/src/BackupWindow.cc (about dialog)
744                 - src/Doxyfile
745                 - rpm/barry.spec
746         - build system tweaks for opensync-plugin, and added a buildgen.sh
747                 for it
748         - added better debug messages in probe.cc and usbwrap.cc's
749                 device discovery code
750         - changed error handling for null interface->altsetting pointers
751                 when doing device discovery in usbwrap.cc.  Seems that
752                 some devices report a higher number in bNumInterfaces
753                 than are really available... in this case, let's
754                 just ignore the missing data and assume success
755         - applied udev script patch #1663986 from Troy Engel
756         - applied barry-bcharge.spec patch #1672178 from Troy Engel
757         - ReleaseChecklist update
758         - added rpm/README based on Troy Engel's patch notes
759         - updated new barry-bcharge.spec for version 0.7, removing patch
760                 dependency
762 Release: version 0.6 - 2007/02/28
763 ------------------------------------------------------------------------------
764 2007/02/28
765         - fixed size checks for device database records larger than 64K
766                 Thanks to Michael Brown for the bug report.
767         - added initial release maintainer scripts
768         - fixed odd backup success message in GUI when doing a backup with
769                 no databases selected in configuration
770                 Thanks to Michael Brown for the bug report.
771         - added udev permissions file patch from Michael Brown
772         - added Michael Brown to AUTHORS
773         - updated README, gui/README, and doc/USB-capture.txt
774         - added -o command line switch to bcharge.cc, and updated man page
775 2007/02/23
776         - changed library behaviour so it only turns on libusb debug output
777                 if in data dump mode.  In btool, -v controls this output.
778         - minor stream formatting fix in btool
779         - added OpenSSL dependency to build for password hash support
780         - made debug dout() output conditional on Init() flag... In btool,
781                 -v now controls this as well
782         - reverse engineered more of the initial probe packets, and
783                 implemented probing in struct based code... changes include:
784                 - added support for "attribute fetch" packets, used at
785                         the beginning of USB conversations
786                 - defined object/attribute id codes for the PIN number
787                 - made Protocol::SocketCommand more robust, and implemented
788                         its sequence number behaviour
789                 - moved ModeSelectCommand into SocketCommand, as it is a
790                         socket 0 level command
791                 - added initial protocol struct: PasswordChallenge
792                 - renamed Barry::Packet to DBPacket
793                 - added ZeroPacket for socket 0 packet creation and analysis
794                 - Barry::Packet is now the base class for the above
795                 - implemented socket 0 behaviour in socket.cc
796                 - changed return values for Send/Receive/Packet/NextRecord
797                         members in the Socket class from bool to void, as they
798                         don't generate errors themselves, but only can
799                         have an error if Usb::Device throws an exception.
800                         Cleaned up all code that called these members as well.
801                 - removed "last status" from Socket class as it was unused
802                 - updated probe.cc to use new socket 0 implementation
803                 - removed two of the hard coded packet handshakes in favour
804                         of socket 0 packets
805                 - updated controller.cc:
806                         - uses new socket 0 implementation
807                         - removed "flag" hack when opening sockets and
808                                 selecting modes, as it should use the
809                                 socket 0 sequence number
810         - added initial, incomplete prototype header for the C API
811         - updated some .cvsignore files
812         - updated TODO
813         - updated ReleaseChecklist.txt, adding rpm spec file
814         - added the following to ZeroPacket:
815                 - ChallengeSeed()
816                 - RemainingTries()
817                 - SocketResponse()
818                 - SocketSqeuence()
819         - moved Command() to base Packet class
820         - added comments to protostructs.h and size constants for the
821                 new PasswordChallenge struct
822         - added password support to Socket and Controller classes
823                 Thanks to Rick Scott's XmBlackBerry for the openssl
824                 password hashing logic.
825         - updated btool to use new password support, and updated its man page
826 2007/02/22
827         - updated Doxygen input files and version, and added to ReleaseChecklist
828         - fixed btool PIN output for LDIF mode, now commented in output
829         - major LDIF overhaul:
830                 - split LDIF specific code out of the record class and
831                         into its own
832                 - fixed "full name" behaviour that added an extra space
833                         in dn attributes, as reported by Troy Engel
834                 - added support for mapping of LDIF attributes to Barry
835                         contact field names
836                 - fixed base64 handling, so attributes are only so encoded
837                         if necessary
838                 - fixed base64 attribute reading inconsistency... some
839                         notes fields were missed in old version if not
840                         encoded
841                 - added support for specifying alternate attribute for
842                         constructing a FQDN, instead of just "cn"
843                 - updated btool and upldif to use new features
844         - large update to btool manpage
845         - fixed initialization bug in Contact constructor (missed RecType)
846 2007/02/15
847         - added ktrans.cc to make reading of kernel usbfs_snoop logs easier
848         - removed commented code from translate.cc
849         - added Pearl handshake support to bcharge.cc, which resets the
850                 Pearl so that the vendor specific 0xFF class exists.
851                 This should allow use of btool on the Pearl.
852         - added Data::AppendHexString to data.cc
853         - added better probing support for the Pearl, so it detects the
854                 Product ID 0x0004 mode, and does a search for class 0xFF
855                 instead of hardcoding it.
856 2007/02/10
857         - applied README patch from Ian Darwin
858         - minor tweaks to README
859         - added missing errno.h header in src/usbwrap.cc for AMD64
860                 Thanks to Jonathan Hudson for reporting the bug.
861         - tightened up size checks in Data::ReleaseBuffer()
862         - stable libusb *does* return the actual length of the USB packet...
863                 fixed this in usbwrap.cc to set the actual size of read data,
864                 and removed the size hacks elsewhere in the code:
865                 probe.cc, protocol.cc, socket.cc, usbwrap.cc
866 2007/02/09
867         - added proper return codes for error conditions in btool.cc
868         - clarified some stream output code in the library, for hex/dec numbers
869         - removed old, non-working connect.cc test program
870         - added iomanip to debug.h
871         - changed usbwrap to call libusb again if EINTR and EAGAIN
872                 This should fix one of the OpenBSD issues
873 2007/02/04
874         - updated AUTHORS
875         - fixed bug in barrybackup GUI that didn't create the target path
876                 if the user didn't do Edit | Config first.
877                 Thanks to Ian Darwin for reporting the bug.
878         - applied gui/src/ConfigFile.cc header fix patch for OpenBSD
879                 from Ian Darwin
880 2007/02/03
881         - added initial btool.1 man page from Ian Darwin
882         - updated man/Makefile.am for new btool.1
883         - updated AUTHORS
884         - applied btool -h help clarification patch from Ian Darwin
885 2007/02/02
886         - reworked exception hierarchy, so applications can handle all
887                 Barry related exceptions, including Usb errors, with
888                 one base class: Barry::Error
889         - fixed all the ripple changes this caused throughout the codebase
890         - added BadPassword exception
891 2007/02/01
892         - version bump in:
893                 - configure.ac
894                 - src/Makefile.am
895                 - src/version.cc
896                 - gui/src/BackupWindow.cc (about dialog)
897         - updated doc/ReleaseChecklist.txt
898         - added usb-level breset.cc command line tool
899         - fixed bug in gui/src/tarfile.* for systems where
900                 sizeof(int) != sizeof(void*)
901                 - TarFile class now uses a plugin style for the compression
902                         operations, to allow for threadsafe versions if needed
903                         in the future.
904                 - also fixed leaked file handle bug in open_compressed()
905                 - Thanks to Jonathan Hudson for reporting this for 64bit systems
906         - minor signed comparison fixes in the library
907         - added better protocol data dumping code in probe.cc
908         - added Usb::Device::BulkDrain(), to prevent Barry from hanging
909                 due to pending reads
911 Release: version 0.5 - 2007/01/26
912 ------------------------------------------------------------------------------
913 2007/01/26
914         - added missing errno.h header to gui/src/util.cc
915         - lots more endian fixes after testing on iMac  
916         - iostream output size fixes
917         - added option to btool to reset the device via software
918         - beefed up exception handling in barrybackup
919         - checked in opensync work-in-progress: trace logging, pointer bugfix
920                 this is still experimental
921         - added aboutdialog.* files from gtkmm24 2.10.6, so we have a dialog
922                 class for systems running older versions of gtkmm, like
923                 Debian stable
924         - uncommented the about box menu handler
925         - added "cleanall" option to root buildgen.sh script
926         - update ReleaseChecklist.txt
927         - removed CVS auto-history strings from aboutdialog.*
928 2007/01/25
929         - found a link between the unknown field in tagged protocol headers
930                 and the unknown field in RecordStateTable entries.  This
931                 field matters when uploading certain databases, such as
932                 Browser Options.  It is unknown what this field really
933                 means, but we're calling it RecType.  Updated the API
934                 to use this in all parser objects and builder objects
935                 and record objects that use it.
936         - changed some uses of uint64_t to uint32_t, in Contact and
937                 Calendar record objects... unique IDs only seem to be
938                 32 bits
939         - added new static function to record classes: GetDefaultRecType()
940                 This returns the default rectype that should work
941                 for that record.  Ideally this should be retrieved from
942                 the device, but in the case where a database has no
943                 records, this info would be good to know.
944         - updated convenience template function Controller::AddRecordByType()
945                 to use GetDefaultRecType()
946         - documented the recurrence data and how to use it in Calendar objects
947         - added data debug output for incoming USB packets in the
948                 socket class... when we ported to the stable libusb
949                 we lost some of the verbose output... this should get it
950                 back.  (In the official release, you need to uncomment
951                 ddout() in debug.h for the full blast of debug output).
952         - backup GUI updates:
953                 - changed error_done signal into a pure error signal,
954                         and changed the logic so the restore continues
955                         even if there was a protocol error on one database
956                 - changed status bar messages to show what's happening
957                         i.e. Backup or Restore
958                 - default to not restore the "Handheld Agent" database as
959                         it appears to be read-only on the device
960                 - added temporary Restore & Backup mode for debugging
961                 - added extra hyphen to backup files to show date/time better
962                 - updated GUI to save and restore the new RecType field
963                         supported now by the library
964 2007/01/21
965         - added future considerations to doc/ReleaseChecklist.txt
966         - applied big endian patch from Jonathan Hudson
967         - changes to patch:
968                 - removed endian.h include from barry.h, since applications
969                         using the library should not care about endianness
970                 - hard coded the path to config.h in endian.h
971                         so that endian.h never makes it into the final
972                         install
973                 - removed DEFAULT_INCLUDES setting from src/Makefile.am
974                         for the same reason
975                 - removed config.h dependency in btool.cc and used library
976                         Version call instead
977         - added big/little endian text to the Barry::Version call
978         - updated AUTHORS
979         - fixed install location of bcharge when building with ./configure;
980                 now goes to sbin/ for both source compile and binary packages
981                 Thanks to Jonathan Hudson for reporting this bug.
982 2007/01/20
983         - added smarter timeout values to controller, and allowed
984                 timeout overrides in the packet, socket, and usbwrap code...
985                 extra timeouts are needed for erasing databases for
986                 some older devices
987         - added an explicit DataDumpParser class to btool.cc, as the
988                 library doesn't always have extreme verbose debugging on...
989                 this makes sure anyone can always get raw database packets
990                 through btool, for development
991         - added thread callback signals for error finishes and erase_db
992                 operations, so the GUI is updated properly
993         - more GUI cleanups (status bar updates, etc)
994         - finished implementation of GUI restore
995         - fixed gtkmm/glibmm exception handling when the exceptions
996                 occur in sigc signal handlers... in that case,
997                 exceptions need to be handled with
998                 Glib::add_exception_handler()
999         - added filename-only reading support to TarFile class
1000         - added pending gui/TODO items
1001 2007/01/19
1002         - backup GUI now properly shows progress
1003         - the buttons become insensitive when backup is busy
1004         - refactored directory check code, and added mkdir check
1005                 when to the backup setup (so the directory exists
1006                 when we try to write to it)
1007         - updated code to use Barry::Data in new namespace
1008 2007/01/18
1009         - moved Data class into Barry namespace
1010 2007/01/13
1011         - updated copyright dates for the new year
1012         - clarified exception message in controller.cc
1013         - fixed pointer initialization bug in controller.cc
1014         - added documentation comments to parser.h and builder.h
1015         - updated ReleaseChecklist.txt
1016         - updated README
1017         - changed Barry library configure scripts to make better
1018                 use of pkg-config for autodetecting dependencies
1019         - added initial Barry Backup GUI (gui/ directory), capable of making
1020                 backups only at this point
1021 2007/01/11
1022         - added doc/ReleaseChecklist.txt
1023         - added version API, returning version number and string
1024         - added Troy Engel to AUTHORS
1025         - added special case to bcharge.cc for the Blackberry Pearl,
1026                 which doesn't reset itself after the charge handshake
1027                 Thanks to Troy Engel for testing.
1028 2007/01/05
1029         - added pkg-config support for the library (libbarry-0.pc.in)
1030         - fixed compile error on g++ 3.3 systems (missing stdint.h
1031                 in probe.h)
1032         - fixed protocol hang at end of Controller operation... in
1033                 controller destructor, it was deleting the USB interface
1034                 before closing the socket at the BlackBerry level, thereby
1035                 leaving the device in Desktop mode
1036 2007/01/04
1037         - support the newer udev packages on Ubuntu, which need slightly
1038                 different rules
1039         - modified bcharge.cc to search for Pearl devices too.
1040                 USB product ID 6
1041         - added Pearl product ID to probe code, but likely not functional
1042                 yet until we find someone able to get a USB capture for us
1043 2006/12/29
1044         - version bump in configure.ac and src/Makefile.am
1046 Release: version 0.4 - 2006/12/29
1047 ------------------------------------------------------------------------------
1048 2006/12/29
1049         - added bcharge.cc to the tools/ directory (whoohoo!)
1050         - added initial release version of rpm/barry.spec (aka bcharge.spec)
1051                 This begins the barry binary release, currently only
1052                 including the bcharge utility, but possibly more in
1053                 the future.  Future binary packages will likely include
1054                 libbarry, libbarry-devel, etc, which barry will then
1055                 depend on.
1056         - added udev rule script for BlackBerry devices
1057         - added man/ directory and bcharge.1 manpage
1058         - added debian/ directory for building deb packages, with initial
1059                 package scripts
1060         - added rpm/make-rpm-tarball.sh for building RPMs
1061         - split out technical docs into separate libbarry.docs file for
1062                 a future Debian install
1063         - added more cleaning to buildgen.sh
1064         - added new udev rule file for Debian stable
1065         - hardcoded g++ to 3.3 in debian/rules as I have multiple versions
1066                 on my system and need to compile releases with stable
1067 2006/12/21
1068         - ported Barry to use the stable branch of libusb
1069                 NOTE: no longer depends on the devel libusb tarball!
1070                         Just use your distro's libusb packages.
1071         - fixed more endian issues
1072         - minor update to TODO
1073 2006/12/15
1074         - moved Exceptions, Hacking, and VersionNotes to doc/
1075         - added doc/USB-capture.txt
1076 2006/12/08
1077         - added Controller::AddRecord() and template helper
1078         - added beginning version of generic RecordFetch<> template
1079         - set default of Barry::Init() to false (no data dump mode)
1080         - added examples/ directory, with first addcontact.cc example
1081 2006/12/07
1082         - added autoconf support based on Peter McAlpine's patch
1083         - renamed Makefiles to Makefile.orig and added script to turn
1084                 on old build system if wanted
1085         - fixed boost-specific error path in btool
1086         - moved platform specific code out of time.h and into time.cc
1087         - moved btool.cc, translate.cc, and upldif.cc out of src/ and
1088                 into their own tools/ subdirectory
1089         - added NEWS file to make autotools happy
1090         - added a "clean" option to the buildgen.sh script... maintainer's
1091                 use only
1092         - reworked autoconf and automake files, to support
1093                 barry as a library, to move the programs into their
1094                 own tools directory, and support a proper installation
1095         - fixed headers in parser.h, btool.cc, and upldif.cc to work
1096                 properly when installed standalone
1097         - added tools/Makefile.plain for testing compiling against
1098                 installed barry library
1099         - added commentary on version number system
1100         - removed Makefile.conf and Makefile.orig, as new autoconf
1101                 system supercedes it
1102         - added support for boost serialization library in autoconf build
1103         - added library version number to autoconf build
1104         - changed boost flag to __BARRY_BOOST_MODE__ to avoid collisions
1105         - removed debug.h dependency from btool.cc
1106         - removed libusb check in favour of specific --with-libusb
1107                 option... may need to revisit this later
1108         - quick installation update in README
1109 2006/12/01
1110         - fixed some missed endian conversions in record.cc and added
1111                 some size checks
1112         - fixed endian issues in time.h
1113         - added 2 more functions to the time zone API, and adjusted
1114                 the time zone table for better defaults in North America
1115         - added btool and upldif to the make install sequence
1116         - added support for Calendar recurrence data
1117         - small doc/TimeZones.txt update
1118 2006/11/24
1119         - added BlackBerry time zone code list, reverse engineered from a 7750
1120         - added GetTimeZone() to convert device time zone codes to useful data
1122 Release: version 0.0.3 - 2006/11/24
1123 ------------------------------------------------------------------------------
1124 2006/11/23
1125         - added return code check to Controller::SaveDatabase()
1126         - fixed Data() class constructor, so it doesn't auto-convert
1127                 from any int
1128         - fixed size checking bug in Packet::ReturnCode() that caused
1129                 uploading to device to fail
1130 2006/11/10
1131         - added Exceptions doc file, documenting the C++ exceptions used,
1132                 and their hierarchy
1133         - fixed small bug in 'make install' which didn't build first
1134         - minor documentation and cleanup in upldif.cc
1135         - added utility functions to the RecordStateTable class,
1136                 GetIndex() and MakeNewRecordId()
1137         - changed btool so that the -d command modifiers can be
1138                 specified multiple times to work with multiple records
1139                 at once
1140         - added Calendar sync code to the opensync module (not complete)
1141         - cleaned up exception handling in the opensync module, making
1142                 more use of the base exception to make sure no
1143                 exceptions leak into the C library code
1145 Release: version 0.0.2 - 2006/10/12
1146 ------------------------------------------------------------------------------
1147 2006/10/12
1148         - fixed casting error in opensync module
1149         - minor updates to documentation to prepare for release
1150 2006/09/29
1151         - added stdint.h to parser.h for uint32_t.  Thanks Ron Gage for
1152                 the bug report
1153 2006/09/08
1154         - large refactoring of the packet parsing and building code,
1155                 splitting the code into 3 groups:
1156                 - record: handles record specific parsing and building...
1157                         this is mostly subfields with CommonField structs
1158                         as their headers, but sometimes has a specific
1159                         header of its own, in the case of email
1160                         Note: email's header is as yet undecoded.
1161                         Record does not know the details of the packet
1162                         formats, only the formats of its own record data.
1163                 - packet: handles building of complete command packets
1164                         and handles parsing of commonly used header values,
1165                         providing an API for it... packet does not know
1166                         the record format details, but does know the
1167                         details of each Database Operation (protocol.h)
1168                         packet format.
1169                         So far, it seems that there is a real separation
1170                         of operation formats and record formats, with the
1171                         record formats being the same even with different
1172                         database operation codes (GET_RECORDS /
1173                         OLD_GET_RECORDS), which was not confirmed before.
1174                         See the header size of the email record after
1175                         refactoring.
1176                 - controller: handles device state, and the management of
1177                         sockets, commands, and checking for response values.
1178                         The Controller object does not know the format
1179                         of either the record or the packet it is sending,
1180                         but does know the protocol handshake logic used
1181                         to talk to the device.
1182         - implemented SetRecord (SET_RECORD_BY_INDEX)... syncing, here
1183                 we come!
1184         - spelling correction in opensync-plugin/AUTHORS
1185 2006/09/01
1186         - added sample hotplug scripts
1187         - added .cvsignore files for doxygen and opensync directories
1188         - added src/endian.h... still need to add configure support to
1189                 handle non-little-endian machines
1190         - added exception handler in opensync plugin commit_change()
1191         - removed the device reset code in probe.cc, as resetting a device
1192                 can renumber the devices in /proc on kernel 2.4.x,
1193                 and cause a failure to reach the device...
1194                 FIXME - this should be changed someday to reset if probing
1195                 fails, and restart the probe on reset, as sometimes
1196                 the blackberry devices respond differently when not reset
1197                 Ideally, the probe protocol should be properly reverse
1198                 engineered.
1199         - added support for retrieving record state table, which is needed
1200                 for smarter syncing
1201         - added support for retrieving, deleting, and clearing the dirty
1202                 flags of individual blackberry device records
1203         - added endian macros throughout the code
1204 2006/07/13
1205         - added opensync-plugin to root Makefile's clean
1206         - updated time conversion calls to match opensync's latest SVN
1207         - added opensync_change_set_changetype() (only add for now,
1208                 for development)
1209         - removed slow sync functions for now
1210 2006/07/07
1211         - added quick "install" makefile target, to src/install by default
1212         - added static library target... this is temporary until autoconf
1213                 stuff is added properly... needed for the opensync plugin
1214         - documented in comments that Barry::BError is intended to be
1215                 the base classes for all exceptions
1216         - added first round of implementation of an opensync plugin, based
1217                 on the example plugin code from the opensync sources
1218 2006/06/22
1219         - added to Contact record class:
1220                 - Clear()
1221                 - ReadLdif() to load and parse LDAP data
1222         - added fragmented send support to Socket class
1223         - added Probe::FindActive() to make client programs more streamlined
1224         - fixed hex/decimal printing of record counts in btool
1225         - added upldif.cc, a utility to take ldapsearch output on stdin
1226                 and upload it to a blackberry
1227         - updated src/.cvsignore
1228 2006/06/16
1229         - added parsing of service book fields:
1230                 - old and new name
1231                 - old and new unique ID (UID)
1232                 - content ID (CID)
1233                 - old and new description
1234                 - DSID
1235                 - bes domain / domain
1236         - date change in legal.txt
1237         - added initial parsing of ServiceBook field 0x09, and calling it
1238                 ServiceBookConfig for now, for lack of a better name
1239         - added parsing for ServiceBook field 0x02 on 72xx Blackberries...
1240                 seems to be a name or description, but doesn't appear
1241                 in the device's own GUI... called "Hidden Name" for now
1242 2006/06/09
1243         - added ServiceBook record class and parser code, based on some
1244                 of Ron Gage's reverse engineering... code is by Chris Frey
1245         - added AUTHORS file
1246         - fixed the libusb set_configuration/claim_interface order
1247                 bug in controller.{h,cc}... already fixed in probe,
1248                 but not controller.  Thanks Ron Gage for finding this.
1249 2006/05/25
1250         - renamed Changelog to ChangeLog in preparation for autoconf
1251         - renamed Todo to TODO in preparation for autoconf
1252 2006/05/18
1253         - make clean cleans up tests properly now
1254 2006/03/31
1255         - turned source code browsing on in Doxyfile
1256         - added LoadDatabaseByName() and LoadDatabaseByType() template members
1257                 to the Controller class
1258                 - new file: controllertmpl.h
1259         - documentation fixes in builder.h
1260         - added static GetDBName() functions to all record classes, in
1261                 support of the template Controller functions
1262         - fleshed out DatabaseDatabase::GetDBNumber() and GetDBName(),
1263                 returning errors properly
1264         - documented sample btool.cc code better, and added example
1265                 of Controller template member usage
1266 2006/03/29
1267         - copyright dates updated for 2006
1268 2006/01/05
1269         - backed out update to latest libusb DEVEL tree, since it is buggy.
1270                 Stick with libusb 2005/11/26
1271 2005/12/30
1272         - added clean target to convenience Makefile
1273         - added Boost to list of dependencies in README
1274         - fixed minor compile warnings in base64.cc
1275         - fixed new USB discovery code, and changed endpoint usage to use
1276                 it, instead of the READ_ENDPOINT and WRITE_ENDPOINT
1277                 constants... constants are now removed
1278                 common.h, controller.cc, probe.cc, probe.h, usbwrap.cc
1279         - added ClearHalt() to Usb::Device (usbwrap.cc)
1280         - updated usbwrap.h to match latest libusb CVS devel tree
1281         - updated README to refer to 2005/12/30 libusb CVS devel tree
1282         - added roadmap to Todo list
1283 2005/12/29
1284         - added convenience Makefile in root directory
1285         - added Hacking document
1286         - minor touchups to README
1287         - added caution warning to README, since this release will support
1288                 delete / overwrite / upload functionality
1289         - minor compile order change in Makefile (speed reasons)
1290         - added dynamic endpoint discovery to probe.cc
1291         - changed claim_interface/set_configuration() function call order in
1292                 probe.cc based on feedback on the libusb mailing list
1293         - added USB discovery code to usbwrap.{h,cc}
1294 2005/12/23
1295         - fixed packing bug in new upload header struct
1296         - renamed CommonField union from data to u to be consistent
1297         - added return_code field to DBAccess struct, for error checking
1298         - added response checking during upload: if response is non-zero
1299                 throw exception in controller.cc
1300         - added sorting operators to record parser classes... when writing
1301                 contact data to the device, it may be important to write
1302                 group link items last, since they reference other contacts...
1303                 This needs to be tested, and if not required, removed.
1304         - added GROUP_FLAG field code to Contact parser class
1305         - fixed offset bug in Contact and Calendar Build() functions
1306         - fixed name bug in Contact::Build(), now output only with data
1307         - added appointment type flag support to Calendar record parser
1308                 class, and "all day event" flag support
1309 2005/12/22
1310         - added autoconf to Todo list
1311         - refactored the protocol structures so that record structs can
1312                 be reused for upload and download
1313         - with new protostructs, more header control is handled by
1314                 controller.cc instead of record.cc parsers and builders
1315         - parser code now accepts an offset, to govern start of record data
1316         - changed Data sizes from int to size_t and removed casts
1317         - removed unneeded Parser::GetHeaderSize() (new protostructs make
1318                 this obsolete)
1319         - added Calendar::Build() for calendar uploads
1320 2005/12/10
1321         - added s11n-boost.h serialization templates for boost::serialization
1322         - added boost::serialization to build
1323         - minor change in usbwrap.cc to display error codes in decimal
1324         - added SizePacket special case code to Socket::Send()... this is
1325                 required when uploaded packet size is a multiple of 0x40,
1326                 a special 3 byte size packet is sent
1327         - moved some record class variables to public: so they can be
1328                 properly serialized
1329         - fixed variable name but in RecordBuilder template
1330         - added -f switch to btool, for saving and loading of record data
1331         - added -s switch to btool, for uploading saved data back to handheld
1332         - added Controller::SaveDatabase()
1333 2005/12/08
1334         - fixed potential casting / pointer bug in controller.cc
1335         - added builder.h, to support uploading
1336         - minor comment fixes in parser.h
1337         - added preliminary Contact protocol record building support
1338         - fixed field order bug in ContactRecord protocol struct
1339         - Contact record.h class now saves unknown Group Link field,
1340                 for later saving
1341 2005/12/07
1342         - added -fno-strict-aliasing to compiler flags so gcc-4.0.x won't
1343                 optimize away protocol struct casts
1344                 see: 
1345                 http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25235
1346                 http://mail-index.netbsd.org/tech-kern/2003/08/11/0001.html
1347                 http://groups.google.ca/group/comp.lang.c++.moderated/ \
1348                         browse_thread/thread/e7bf096832526f8e/5714701b \
1349                         02a2a3cc?hl=en#5714701b02a2a3cc
1350         - changed headers so that any low level protocol-specific sizes and
1351                 structs are completely hidden in the library...
1352                 this adds library-only header: protostructs.h
1354 Release: version 0.0.1 - 2005/11/25
1355 ------------------------------------------------------------------------------
1356 2005/11/25
1357         - added barry.h for documentation purposes and application usage
1358         - updated README for release
1359         - renamed SBError exception class to BError
1360         - updated Doxyfile to version 1.4.5
1361         - added more doxygen comments
1362 2005/11/24
1363         - added conversion routines (and tests) between time_t and min1900_t
1364         - added -v option to btool to dynamically control protocol dumping
1365         - removed duplicated database database table display in controller.cc
1366         - minor spelling corrections
1367         - added copyright to usbwrap.{h,cc} as per earlier meeting
1368         - added support for Old protocol Calendar entries
1369 2005/11/20
1370         - added legal.txt, to save typing when adding new source files
1371         - ignore test-base64 file (cvsignore)
1372         - added contact-to-ldif generation, and updated supporting code
1373         - added argument to btool to support contact-to-ldif operation
1374         - added Contact::GetPostalAddress()
1375         - added README documentation in preparation for future release
1376 2005/11/19
1377         - added parser.{h,cc} virtual wrapper to generalize LoadDatabase()
1378         - added code to socket.cc's Packet() command to re-receive on
1379                 reception of empty packets... this seems to be a signal
1380                 from the device that it needs more time for long transfers
1381                 Current limit: 10 blank packets before exception is thrown
1382                 Observed maximum blank count: 1
1383         - added MessageRecord and OldMessageRecord to protocol.h
1384         - changed common record field structs to one CommonField struct
1385         - increased default USB timeout to 10 seconds (some loaded devices
1386                 seem to need more time...)
1387         - reorganized record.{h,cc} to try to reduce the code duplication
1388         - record.h classes now "know" the sizes of their corresponding
1389                 protocol structs... this may cause trouble down the line
1390                 with Python, if used(?)
1391         - added Message class for Email records
1392         - removed the "Get*" database functions and replaced with
1393                 general LoadDatabase() call, which loads any database
1394                 available, and parses it with a Parser object
1395         - added GetDBID() for searching for database numbers via name
1396         - added test code to retrieve and display all email
1397         - cleaned up comments
1398         - renamed blackberry.{h,cc} to controller.{h,cc}
1399         - renamed bbtool.cc to btool.cc
1400         - added Makefile.conf
1401         - added copyright notices to source files
1402         - added COPYING file with GPL
1403         - put parser in Barry namespace, and added auto_ptr-like mode for
1404                 store object pointers
1405         - added doxygen docs
1406         - added header comments to convo.awk script
1407         - removed Test() function in Controller object, and made class
1408                 better suited to its general API purpose
1409         - changed OpenMode() so it loads command table and DBDB... it is now
1410                 a public API function
1411         - moved Controller test code to btool.cc and made tool more
1412                 generically useful... can now download any DB by name on
1413                 the command line
1414         - added mode checks to Controller
1415         - added -t and -d command line options to btool
1416         - added base64 routines from John Walker / Fourmilab and Citadel/UX
1417         - converted base64 routines into an API, instead of hardcoded
1418                 file based
1419 2005/11/18
1420         - changed project name to Barry, including namespaces
1421         - renamed sbcommon.* to common.*
1422         - increased USB default timeout to 2 seconds
1423         - fixed formatting bug in Data operator<< output
1424         - cleaned up the protocol packet structs, getting rid of the
1425                 confusing param/simple split... param is now the tableCmd
1426                 from the Command Table
1427         - moved protocol structs from record.h to protocol.h
1428         - added support for older version of the USB protocol, which matches
1429                 the Cassis spec more closely
1430         - fixed the hardcoded offsets in blackberry.cc's protocol parsing
1431         - fixed Socket::Close() so on error, socket flags are reset.
1432                 This stops Close() from being called twice on exception
1433                 destructors
1434 2005/11/17
1435         - added Doxyfile to the project
1436         - tuned Makefile
1437         - added mode selection support to Blackberry class (RIM Desktop,
1438                 RIM Bypass, and RIM_JavaLoader)
1439                 Mode selection governs which socket is used in subsequent
1440                 data transfers.
1441         - added Command Table parsing and protocol support
1442                 Blackberry class, and CommandTable record class
1443         - added Database database parsing and protocol support
1444                 Blackberry class and DatabaseDatabase record class
1445         - added Address book retrieval support - dumps data to stdout for now
1446         - fixed bug in CopyOnWrite mode in Data class, where could allocate
1447                 less buffer than data copied
1448         - added "easy exception" debug output macro
1449         - fixed minor spelling error in protocol.cc
1450         - fixed ModeSelectCommand protocol structure - it is not a parameter
1451                 command, but uses the unknown slots for socket and flag
1452                 data
1453         - removed hardcoded socket numbers from protocol.h
1454         - fixed bug in socket.cc:Open() where packet size was not properly
1455                 saved
1456         - implemented socket::Close()
1457         - fixed sequence number checks, so it is reset properly on socket 0
1458         - added Socket::NextRecord() for multiple record data transfers
1459         - fixed input handling bug in translate.cc
1460 2005/11/11
1461         - added .cvsignore files to project
1462         - added README notes to document the source architecture
1463         - added dbsetup data script, which shows how to get into database
1464                 mode, using the RIM Desktop mode, and open a socket
1465         - added blackberry.{h,cc} class
1466         - added command line parameters to bbtool.cc
1467                 -l = list only
1468                 -p = specify pin of blackberry device
1469         - added blackberry test code in bbtool.cc - debugging the initial
1470                 opening protocol: sockets, modes, etc... see dbsetup for
1471                 results
1472         - added copy-on-write functionality to Data class, so it can be used
1473                 with plain data buffers with little performance impact
1474         - added eout() and ddout() debugging - to separate:
1475                 - regular debug output
1476                 - exception debug output (should probably be logged to
1477                         syslog someday, and never turned off)
1478                 - raw data dump output
1479         - changed errno SBError exception handler to try to decode the error
1480                 numbers into english (limited success)
1481         - fixed probe and socket USB Bulk message handling, so they don't
1482                 use PollCompletions(), but use IO::Wait() (libusb_io_wait())
1483         - added common packet size checker in protocol.cc
1484         - fixed unpacked protocol packet structs... using gcc's
1485                 __attribute__ ((packed)) ... see protocol.h
1486         - added ModeSelectCommand structure (protocol.h)
1487         - finished Socket::Open() call  (Close() not yet implemented)
1488         - moved Socket::Send/Receive() out of private, as they can be used
1489                 for socket 0 operations.
1490         - cleaned up pointer management with macros:
1491                 MAKE_PACKET()
1492                 COMMAND()
1493                 IS_COMMAND()
1494         - added IO::Wait() and IO::Cancel() to correspond with libusb API
1495         - added datadumping in usbwrap for easy protocol capture
1496         - added preliminary record.{h,cc} classes
1497         - added Contact record parsing, and test code
1498 2005/10/20
1499         - syncberry tree started