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