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