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