TODO

   1 This file contains features that need work.  If you wish to tackle
   2 any of them, please post a quick message to the mailing list of your
   3 intentions, in order to avoid duplication of effort.
   4
   5 If you would like help or more information on any of these items,
   6 please ask on the mailing list as well.
   7
   8 - Chris
   9 <cdfrey@foursquare.net>
  10 December 2007
  11
  12
  13
  14 Porting opensync plugin to opensync 0.40
  15 ----------------------------------------
  16 There's two options to this item:
  17
  18         - simple way
  19         - proper way
  20
  21 The difference between opensync 0.22 and 0.40 involves some API changes.
  22 You should be able to note the changes in the example plugin code once
  23 0.40 is released.
  24
  25 The simple way involves merely updating Barry's opensync plugin to match
  26 the new API.  This shouldn't be too difficult, but you may run across
  27 some small surprises.
  28
  29 The proper way involves:
  30
  31         - switching from the vcard/vevent formats to the opensync XML
  32                 formats
  33         - switching from storing state information in text files to
  34                 storing it in the built in database (optional)
  35         - making use of the new opensync time APIs to properly support
  36                 timezones for all time operations
  37
  38 Switching away from text based vcard and vevent formats will remove
  39 the burden of raw data parsing and formatting from the plugin itself,
  40 and make use of the more tested opensync library.  Any bugs fixed
  41 in opensync's parsers will automatically fix bugs in the Barry plugin.
  42
  43 Switching state storage formats may allow for greater flexibility
  44 in supporting multiple devices.  This needs more research, but it
  45 is the "way things are done" in opensync, and likely worth moving
  46 in that direction.
  47
  48 Support for timezones will likely stress the opensync API as well as
  49 the Barry API, but definitely needs to be done for completeness on both
  50 sides of the equation.
  51
  52 Estimated time:   simple way: 10 hours if lucky
  53                   proper way: open ended
  54
  55
  56
  57 Adding support for Tasks database to opensync plugin
  58 ----------------------------------------------------
  59 This will require research into the proper vformat for tasks.  If
  60 the above port to 0.40 is complete, then use the XML format.  If not,
  61 then find the appropriate v-format.
  62
  63 Estimated time: 16 hours
  64 Depending on: ideally, wait for 0.40 XML format support
  65
  66
  67
  68 Adding support for Memos (notes) to opensync plugin
  69 ---------------------------------------------------
  70 Same as above, for Tasks.  If done together, may be able to save some time.
  71
  72 Estimated time: 16 hours
  73 Depending on: ideally, wait for 0.40 XML format support
  74
  75
  76
  77 Reverse engineering java loader protocol
  78 ----------------------------------------
  79 This has not been done by any opensource Blackberry project out there,
  80 to my knowledge, and would be most useful to Blackberry application
  81 developers.
  82
  83 If you are a Blackberry app developer, this may interest you.
  84
  85 Estimated time: open ended
  86
  87
  88
  89 Adding GPRS / CDMA modem support
  90 --------------------------------
  91 Barry has had plans to include modem support for a few months now, but
  92 it has not yet percolated to the surface.
  93
  94 The primary source for modem protocol specifics is the XmBlackBerry
  95 project (http://sourceforge.net/projects/XmBlackBerry).  Barry's
  96 goal is to create a standalone pppob utility that can be configured
  97 with pppd similarly to pppoe.
  98
  99 The tricky part of modem support is that it requires threading support,
 100 especially if you intend to use the database at the same time.
 101 This leads to some architectural challenges that need to be dealt with:
 102
 103         As Barry is not a single application, how do you access the
 104         database while pppob is using the modem?
 105
 106 There are two viable ways of dealing with this.  One involves placing
 107 a (hopefully thin) driver in the kernel, and the other involves using
 108 a daemon and RPC calls.
 109
 110 My preference is to implement this using RPC calls if needed, and hammer
 111 out all the implementation details in user space.  Once they are well
 112 understood, a smaller kernel driver hook may be more easily written
 113 that supports routing messages according to socket or application
 114 needs.  For example, one application may register an interest in
 115 database messages, another in javaloader messages, and another in the
 116 multiple modem socket messages.
 117
 118 There is currently a development branch in CVS that intends to support
 119 optional threading support in the Barry library, so that at least
 120 it should be possible to use both the database and the modem in the
 121 same application.
 122
 123 Estimated tasks (assuming threading support is finished):
 124         - copy protocol specifics from XmBlackBerry
 125         - add Serial class for controller interface
 126         - write and test pppob
 127         - write pppob manpage
 128 Estimated time: 8 hours
 129
 130
 131
 132 Finish the threaded architecture changes in CVS branch
 133 ------------------------------------------------------
 134 For the reasons outlined above, for modem support, this CVS branch
 135 needs to be finished.  For more information, contact the mailing list.
 136
 137 Estimated tasks:
 138         - write SocketRouting code
 139         - refactor the controller class into RAII behaving
 140                 mode classes, such as Desktop, Serial, and
 141                 Javaloader, that operate on top of Controller
 142         - testing threaded and non-threaded behaviour
 143         - testing performance impact
 144 Estimated time: 20 hours
 145
 146
 147
 148 Add bluetooth serial support
 149 ----------------------------
 150 It is reported that it is possible to access the database through
 151 Bluetooth using the older Blackberry serial protocol.  XmBlackBerry
 152 has support for this and may be used as a reference.
 153
 154 The goal here would be to hide the bluetooth access behind the
 155 same Barry library API, so that syncing with the opensync plugin
 156 would be seamless whether plugged in via USB or Bluetooth.
 157
 158 Estimated tasks:
 159         - research and design serial protocol stack to reuse as much
 160                 library code as possible
 161 Estimated time: unknown
 162
 163
 164
 165 Write simple GUI for streamlining sync setup and action
 166 -------------------------------------------------------
 167 Syncing setup and operation is currently a tedious, complicated task.
 168 A GUI that performed all the detailed setup and configuration work,
 169 for a Blackberry-specific sync, using opensync libraries and plugins
 170 for Evolution, Sunbird, etc, would be very helpful.
 171
 172 This would be much easier for an experienced GUI programmer, but there is
 173 a learning curve for the opensync API.
 174
 175 Estimated tasks:
 176         - document the settings required for Blackberry, and
 177                 all intended plugins required
 178         - write application that:
 179                 - does the opensync configuration through the opensync
 180                         API directly
 181                 - scans the USB bus for available Blackberry devices using
 182                         Barry
 183                 - lives in the system tray watching for Blackberry devices
 184         - if aiming for super ease of use, script a source build of
 185                 all needed opensync components and install in private
 186                 area to avoid conflict with system
 187 Estimated time: unknown
 188 Note: Depending how fast HAL, OpenSync, and Conduit are implemented,
 189         this may never be needed... but if it existed today, there's a
 190         lot of users who would be very happy...
 191
 192
 193
 194 Document the USB protocol
 195 -------------------------
 196 Currently the only english documentation for the Blackberry protocol
 197 is the webpage by the Cassis project (found at
 198 http://off.net/cassis/protocol-description.html).
 199
 200 The USB protocol is not nearly so well documented.  The best documentation
 201 available can be found in the Barry header files: protocol.h and
 202 protostructs.h.
 203
 204 Translating the code into documentation (into a wiki, that will hopefully
 205 soon be available) is a great way to get involved in the project and
 206 learn a lot about the Blackberry from a low level.
 207
 208 Unfortunately, Jedi mind tricks don't often work when trying to convince
 209 people to write documentation for me... :-)
 210
 211 Estimated tasks:
 212         - write, write, write
 213 Estimated time: 40 hours (documentation expands to fill available time...)
 214
 215
 216
 217 Code cleanup
 218 ------------
 219 Code can always be improved.  There are two big ways to help:
 220
 221         - write an application using the Barry library
 222         - improve the Barry library itself and send patches
 223
 224 By writing an application, you can provide crucial feedback on the ease
 225 of use of the Barry API.  I'm very eager for such feedback.
 226
 227 Secondly, there is currently a lot of code ducplication in the record
 228 classes, and a careful refactoring is required.  I would be open to a class
 229 hierarchy, with possibly private or protected inheritance.  My primary
 230 concern is object safety when using the record classes as objects in
 231 STL containers, with a secondary concern to make it easier to
 232 abstractly work with a record.  This implies a careful mix of
 233 virtual functions and a generic record base class.  Patches in this
 234 area will be thoughtfully considered.
 235
 236 Estimated tasks (refactoring):
 237         - design safe hierarchy
 238         - move common code to base class
 239         - make sure all record classes use the common record API
 240         - test
 241 Estimated time: 7 hours
 242
 243
 244
 245 C API wrapper
 246 -------------
 247 For those that write applications in C, a C API wrapper has been started
 248 in the cbarry.h header.  It has not yet been implemented, but should be
 249 straightforward.
 250
 251 Estimated tasks:
 252         - finish some API design work (head not fully complete)
 253         - implement all functions (about 50)
 254         - write test application, or test suite, for C API
 255 Estimated time: unknown
 256
 257
 258
 259 Python wrappers and example code
 260 --------------------------------
 261 For those that write applications in Python, a SWIG wrapper has been
 262 started by H Miz Jones.  This is partially functional, and involves
 263 working with the Barry API, and may introduce changes to it depending
 264 how hard it is to translate things to the Python world.
 265
 266 The SWIG wrapper scripts have not yet been publically released, but
 267 please contact me if you are interested.
 268
 269 Estimated tasks:
 270         - finish C++ / Python integration (possible template issues)
 271         - finish SWIG wrapper
 272 Estimated time: unknown
 273
 274
 275
 276 Command line backup and restore
 277 -------------------------------
 278 The only command line backup currently available is the one in btool,
 279 using the -f and -s switches.  This does not backup exact data from
 280 the device, but parses it, stores it in the Boost serialization format,
 281 and then reverses the process for restore.  This is a great test
 282 for the Barry library, but not so great for backup, since not all
 283 databases can be parsed.
 284
 285 There is already an exact backup and restore interface with the GUI, but
 286 there is a lot of useful functionality trapped in a layer of GUI
 287 that could be just as useful from the command line.  Tasks such as a nightly
 288 cron backup of any Blackberry devices attached to the system would be more
 289 easily done via command line.
 290
 291 You could add command line arguments to the barrybackup program to skip
 292 the GUI (tricky and possibly error prone), or you could pull the backup
 293 functionality into a standalone command line utility (more work, but smarter
 294 in the long run).  This is mostly a code refactoring job, consisting of
 295 all working code that's already there, and I know there are people
 296 who would thank you. :-)
 297
 298 Estimated tasks:
 299         - split out tar and backup functionality code into shared library
 300         - write and test command line tool
 301 Estimated time: 6 hours
 302
 303
 304
 305 Misc Low Level Todo Items:
 306 --------------------------
 307 - test whether sorting of contact records is required before
 308         uploading data to the device... test whether it is ok
 309         to upload a GroupLink item in the middle of a contact
 310         upload, even before all the groups have been sent...
 311         if ok, remove the sorting code from Contact, Message, and
 312         Calendar classes
 313