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