2006/07/13
[barry.git] / ChangeLog
blob97c783943f8707ecb8268d87d5bad91dad2a26fe
1 Release: version 0.0.2 - 2005/??/??
2 ------------------------------------------------------------------------------
3 2006/07/13
4         - added opensync-plugin to root Makefile's clean
5         - updated time conversion calls to match opensync's latest SVN
6         - added opensync_change_set_changetype() (only add for now,
7                 for development)
8         - removed slow sync functions for now
9 2006/07/07
10         - added quick "install" makefile target, to src/install by default
11         - added static library target... this is temporary until autoconf
12                 stuff is added properly... needed for the opensync plugin
13         - documented in comments that Barry::BError is intended to be
14                 the base classes for all exceptions
15         - added first round of implementation of an opensync plugin, based
16                 on the example plugin code from the opensync sources
17 2006/06/22
18         - added to Contact record class:
19                 - Clear()
20                 - ReadLdif() to load and parse LDAP data
21         - added fragmented send support to Socket class
22         - added Probe::FindActive() to make client programs more streamlined
23         - fixed hex/decimal printing of record counts in btool
24         - added upldif.cc, a utility to take ldapsearch output on stdin
25                 and upload it to a blackberry
26         - updated src/.cvsignore
27 2006/06/16
28         - added parsing of service book fields:
29                 - old and new name
30                 - old and new unique ID (UID)
31                 - content ID (CID)
32                 - old and new description
33                 - DSID
34                 - bes domain / domain
35         - date change in legal.txt
36         - added initial parsing of ServiceBook field 0x09, and calling it
37                 ServiceBookConfig for now, for lack of a better name
38         - added parsing for ServiceBook field 0x02 on 72xx Blackberries...
39                 seems to be a name or description, but doesn't appear
40                 in the device's own GUI... called "Hidden Name" for now
41 2006/06/09
42         - added ServiceBook record class and parser code, based on some
43                 of Ron Gage's reverse engineering... code is by Chris Frey
44         - added AUTHORS file
45         - fixed the libusb set_configuration/claim_interface order
46                 bug in controller.{h,cc}... already fixed in probe,
47                 but not controller.  Thanks Ron Gage for finding this.
48 2006/05/25
49         - renamed Changelog to ChangeLog in preparation for autoconf
50         - renamed Todo to TODO in preparation for autoconf
51 2006/05/18
52         - make clean cleans up tests properly now
53 2006/03/31
54         - turned source code browsing on in Doxyfile
55         - added LoadDatabaseByName() and LoadDatabaseByType() template members
56                 to the Controller class
57                 - new file: controllertmpl.h
58         - documentation fixes in builder.h
59         - added static GetDBName() functions to all record classes, in
60                 support of the template Controller functions
61         - fleshed out DatabaseDatabase::GetDBNumber() and GetDBName(),
62                 returning errors properly
63         - documented sample btool.cc code better, and added example
64                 of Controller template member usage
65 2006/03/29
66         - copyright dates updated for 2006
67 2006/01/05
68         - backed out update to latest libusb DEVEL tree, since it is buggy.
69                 Stick with libusb 2005/11/26
70 2005/12/30
71         - added clean target to convenience Makefile
72         - added Boost to list of dependencies in README
73         - fixed minor compile warnings in base64.cc
74         - fixed new USB discovery code, and changed endpoint usage to use
75                 it, instead of the READ_ENDPOINT and WRITE_ENDPOINT
76                 constants... constants are now removed
77                 common.h, controller.cc, probe.cc, probe.h, usbwrap.cc
78         - added ClearHalt() to Usb::Device (usbwrap.cc)
79         - updated usbwrap.h to match latest libusb CVS devel tree
80         - updated README to refer to 2005/12/30 libusb CVS devel tree
81         - added roadmap to Todo list
82 2005/12/29
83         - added convenience Makefile in root directory
84         - added Hacking document
85         - minor touchups to README
86         - added caution warning to README, since this release will support
87                 delete / overwrite / upload functionality
88         - minor compile order change in Makefile (speed reasons)
89         - added dynamic endpoint discovery to probe.cc
90         - changed claim_interface/set_configuration() function call order in
91                 probe.cc based on feedback on the libusb mailing list
92         - added USB discovery code to usbwrap.{h,cc}
93 2005/12/23
94         - fixed packing bug in new upload header struct
95         - renamed CommonField union from data to u to be consistent
96         - added return_code field to DBAccess struct, for error checking
97         - added response checking during upload: if response is non-zero
98                 throw exception in controller.cc
99         - added sorting operators to record parser classes... when writing
100                 contact data to the device, it may be important to write
101                 group link items last, since they reference other contacts...
102                 This needs to be tested, and if not required, removed.
103         - added GROUP_FLAG field code to Contact parser class
104         - fixed offset bug in Contact and Calendar Build() functions
105         - fixed name bug in Contact::Build(), now output only with data
106         - added appointment type flag support to Calendar record parser
107                 class, and "all day event" flag support
108 2005/12/22
109         - added autoconf to Todo list
110         - refactored the protocol structures so that record structs can
111                 be reused for upload and download
112         - with new protostructs, more header control is handled by
113                 controller.cc instead of record.cc parsers and builders
114         - parser code now accepts an offset, to govern start of record data
115         - changed Data sizes from int to size_t and removed casts
116         - removed unneeded Parser::GetHeaderSize() (new protostructs make
117                 this obsolete)
118         - added Calendar::Build() for calendar uploads
119 2005/12/10
120         - added s11n-boost.h serialization templates for boost::serialization
121         - added boost::serialization to build
122         - minor change in usbwrap.cc to display error codes in decimal
123         - added SizePacket special case code to Socket::Send()... this is
124                 required when uploaded packet size is a multiple of 0x40,
125                 a special 3 byte size packet is sent
126         - moved some record class variables to public: so they can be
127                 properly serialized
128         - fixed variable name but in RecordBuilder template
129         - added -f switch to btool, for saving and loading of record data
130         - added -s switch to btool, for uploading saved data back to handheld
131         - added Controller::SaveDatabase()
132 2005/12/08
133         - fixed potential casting / pointer bug in controller.cc
134         - added builder.h, to support uploading
135         - minor comment fixes in parser.h
136         - added preliminary Contact protocol record building support
137         - fixed field order bug in ContactRecord protocol struct
138         - Contact record.h class now saves unknown Group Link field,
139                 for later saving
140 2005/12/07
141         - added -fno-strict-aliasing to compiler flags so gcc-4.0.x won't
142                 optimize away protocol struct casts
143                 see: 
144                 http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25235
145                 http://mail-index.netbsd.org/tech-kern/2003/08/11/0001.html
146                 http://groups.google.ca/group/comp.lang.c++.moderated/ \
147                         browse_thread/thread/e7bf096832526f8e/5714701b \
148                         02a2a3cc?hl=en#5714701b02a2a3cc
149         - changed headers so that any low level protocol-specific sizes and
150                 structs are completely hidden in the library...
151                 this adds library-only header: protostructs.h
153 Release: version 0.0.1 - 2005/11/25
154 ------------------------------------------------------------------------------
155 2005/11/25
156         - added barry.h for documentation purposes and application usage
157         - updated README for release
158         - renamed SBError exception class to BError
159         - updated Doxyfile to version 1.4.5
160         - added more doxygen comments
161 2005/11/24
162         - added conversion routines (and tests) between time_t and min1900_t
163         - added -v option to btool to dynamically control protocol dumping
164         - removed duplicated database database table display in controller.cc
165         - minor spelling corrections
166         - added copyright to usbwrap.{h,cc} as per earlier meeting
167         - added support for Old protocol Calendar entries
168 2005/11/20
169         - added legal.txt, to save typing when adding new source files
170         - ignore test-base64 file (cvsignore)
171         - added contact-to-ldif generation, and updated supporting code
172         - added argument to btool to support contact-to-ldif operation
173         - added Contact::GetPostalAddress()
174         - added README documentation in preparation for future release
175 2005/11/19
176         - added parser.{h,cc} virtual wrapper to generalize LoadDatabase()
177         - added code to socket.cc's Packet() command to re-receive on
178                 reception of empty packets... this seems to be a signal
179                 from the device that it needs more time for long transfers
180                 Current limit: 10 blank packets before exception is thrown
181                 Observed maximum blank count: 1
182         - added MessageRecord and OldMessageRecord to protocol.h
183         - changed common record field structs to one CommonField struct
184         - increased default USB timeout to 10 seconds (some loaded devices
185                 seem to need more time...)
186         - reorganized record.{h,cc} to try to reduce the code duplication
187         - record.h classes now "know" the sizes of their corresponding
188                 protocol structs... this may cause trouble down the line
189                 with Python, if used(?)
190         - added Message class for Email records
191         - removed the "Get*" database functions and replaced with
192                 general LoadDatabase() call, which loads any database
193                 available, and parses it with a Parser object
194         - added GetDBID() for searching for database numbers via name
195         - added test code to retrieve and display all email
196         - cleaned up comments
197         - renamed blackberry.{h,cc} to controller.{h,cc}
198         - renamed bbtool.cc to btool.cc
199         - added Makefile.conf
200         - added copyright notices to source files
201         - added COPYING file with GPL
202         - put parser in Barry namespace, and added auto_ptr-like mode for
203                 store object pointers
204         - added doxygen docs
205         - added header comments to convo.awk script
206         - removed Test() function in Controller object, and made class
207                 better suited to its general API purpose
208         - changed OpenMode() so it loads command table and DBDB... it is now
209                 a public API function
210         - moved Controller test code to btool.cc and made tool more
211                 generically useful... can now download any DB by name on
212                 the command line
213         - added mode checks to Controller
214         - added -t and -d command line options to btool
215         - added base64 routines from John Walker / Fourmilab and Citadel/UX
216         - converted base64 routines into an API, instead of hardcoded
217                 file based
218 2005/11/18
219         - changed project name to Barry, including namespaces
220         - renamed sbcommon.* to common.*
221         - increased USB default timeout to 2 seconds
222         - fixed formatting bug in Data operator<< output
223         - cleaned up the protocol packet structs, getting rid of the
224                 confusing param/simple split... param is now the tableCmd
225                 from the Command Table
226         - moved protocol structs from record.h to protocol.h
227         - added support for older version of the USB protocol, which matches
228                 the Cassis spec more closely
229         - fixed the hardcoded offsets in blackberry.cc's protocol parsing
230         - fixed Socket::Close() so on error, socket flags are reset.
231                 This stops Close() from being called twice on exception
232                 destructors
233 2005/11/17
234         - added Doxyfile to the project
235         - tuned Makefile
236         - added mode selection support to Blackberry class (RIM Desktop,
237                 RIM Bypass, and RIM_JavaLoader)
238                 Mode selection governs which socket is used in subsequent
239                 data transfers.
240         - added Command Table parsing and protocol support
241                 Blackberry class, and CommandTable record class
242         - added Database database parsing and protocol support
243                 Blackberry class and DatabaseDatabase record class
244         - added Address book retrieval support - dumps data to stdout for now
245         - fixed bug in CopyOnWrite mode in Data class, where could allocate
246                 less buffer than data copied
247         - added "easy exception" debug output macro
248         - fixed minor spelling error in protocol.cc
249         - fixed ModeSelectCommand protocol structure - it is not a parameter
250                 command, but uses the unknown slots for socket and flag
251                 data
252         - removed hardcoded socket numbers from protocol.h
253         - fixed bug in socket.cc:Open() where packet size was not properly
254                 saved
255         - implemented socket::Close()
256         - fixed sequence number checks, so it is reset properly on socket 0
257         - added Socket::NextRecord() for multiple record data transfers
258         - fixed input handling bug in translate.cc
259 2005/11/11
260         - added .cvsignore files to project
261         - added README notes to document the source architecture
262         - added dbsetup data script, which shows how to get into database
263                 mode, using the RIM Desktop mode, and open a socket
264         - added blackberry.{h,cc} class
265         - added command line parameters to bbtool.cc
266                 -l = list only
267                 -p = specify pin of blackberry device
268         - added blackberry test code in bbtool.cc - debugging the initial
269                 opening protocol: sockets, modes, etc... see dbsetup for
270                 results
271         - added copy-on-write functionality to Data class, so it can be used
272                 with plain data buffers with little performance impact
273         - added eout() and ddout() debugging - to separate:
274                 - regular debug output
275                 - exception debug output (should probably be logged to
276                         syslog someday, and never turned off)
277                 - raw data dump output
278         - changed errno SBError exception handler to try to decode the error
279                 numbers into english (limited success)
280         - fixed probe and socket USB Bulk message handling, so they don't
281                 use PollCompletions(), but use IO::Wait() (libusb_io_wait())
282         - added common packet size checker in protocol.cc
283         - fixed unpacked protocol packet structs... using gcc's
284                 __attribute__ ((packed)) ... see protocol.h
285         - added ModeSelectCommand structure (protocol.h)
286         - finished Socket::Open() call  (Close() not yet implemented)
287         - moved Socket::Send/Receive() out of private, as they can be used
288                 for socket 0 operations.
289         - cleaned up pointer management with macros:
290                 MAKE_PACKET()
291                 COMMAND()
292                 IS_COMMAND()
293         - added IO::Wait() and IO::Cancel() to correspond with libusb API
294         - added datadumping in usbwrap for easy protocol capture
295         - added preliminary record.{h,cc} classes
296         - added Contact record parsing, and test code
297 2005/10/20
298         - syncberry tree started