Thu, 09 Sep 2010 13:11:49 -0400 http://bugs.horde.org/ticket/5175 Restructuring the Kolab driver Currently each Kolab driver in the different applications needs to know a lot about the XML format used for storing groupware objects like notes, tasks etc. on the groupware server. This makes it hard if not impossible to cache the data on the way from the IMAP storage to the groupware application. On the other hand caching is necessary to allow Horde to work on a Kolab server that stores several thousand groupware objects. The attached patches and files implement a new framework that restructure the Kolab driver so that each application driver only needs to transfer data as a hash. This hash can also be cached by the main Kolab module. The patches will not destroy the old functionality of the Kolab driver and only add the new framework to the classes. I am going to attach all parts of this patch to this bug, but please tell me if I should try to seperate this to a larger degree. Wed, 28 Mar 2007 19:08:20 -0400 http://bugs.horde.org/ticket/5175#t30742 This marks some functions in the global Kolab driver as deprecated. Wed, 28 Mar 2007 19:09:18 -0400 http://bugs.horde.org/ticket/5175#t30743 Some files will get added to the package. Wed, 28 Mar 2007 19:09:56 -0400 http://bugs.horde.org/ticket/5175#t30744 The main XML-Wrapper that now does all of the XML handling. This belongs in Kolab/Kolab/XML.php Wed, 28 Mar 2007 19:11:11 -0400 http://bugs.horde.org/ticket/5175#t30745 The XML-class lends itself to unit testing. This is a test script that belongs in Kolab/tests/kolab_xml.phpt Wed, 28 Mar 2007 19:12:39 -0400 http://bugs.horde.org/ticket/5175#t30746 This defines the XML format for notes and belongs in Kolab/Kolab/XML/note.php Wed, 28 Mar 2007 19:13:27 -0400 http://bugs.horde.org/ticket/5175#t30747 This defines the XML format for tasks and belongs in Kolab/Kolab/XML/task.php Wed, 28 Mar 2007 19:14:03 -0400 http://bugs.horde.org/ticket/5175#t30748 A new Kolab driver for mnemo that uses the new framework. Wed, 28 Mar 2007 19:15:08 -0400 http://bugs.horde.org/ticket/5175#t30749 A new Kolab driver for nag that uses the new framework. Wed, 28 Mar 2007 19:16:26 -0400 http://bugs.horde.org/ticket/5175#t30750 Turba and Kronolith have not yet been transferred to the new framework. Wed, 28 Mar 2007 19:17:16 -0400 http://bugs.horde.org/ticket/5175#t30751 I'm not sure I like the bc break of just dieing if people aren't using CVS HEAD. But I guess Kolab support hasn't been _really_ stable in releases... other thoughts here? Wed, 28 Mar 2007 19:43:06 -0400 http://bugs.horde.org/ticket/5175#t30754 Lack of stability of the older driver was the reason for choosing this solution. If you feel that is not ok I think there are two possible alternatives: 1) adding this as a second possible Kolab driver (as kolab2.php) or 2) having the old and the new driver in the kolab.php class with a wrapper that decides automatically based on the capabilities of the Kolab module Thu, 29 Mar 2007 02:15:23 -0400 http://bugs.horde.org/ticket/5175#t30761 I would say that 2) would be the most elegant solution. But I can also envision an exception from our BC rule. Thu, 29 Mar 2007 05:29:29 -0400 http://bugs.horde.org/ticket/5175#t30767 I'm mostly okay with a BC break; it'd be even better if there was a good way to just pear upgrade horde/Kolab, but that's probably not going to work for most setups now. Thu, 29 Mar 2007 11:25:17 -0400 http://bugs.horde.org/ticket/5175#t30785 Thomas Jarosch prepared the Turba driver and I fixed some issues on the nag driver. In addition I moved some data processing to the XML drivers so that this effort happens before caching the data. XML driver for notes Tue, 03 Apr 2007 03:21:27 -0400 http://bugs.horde.org/ticket/5175#t31079 XML driver for tasks Tue, 03 Apr 2007 03:21:56 -0400 http://bugs.horde.org/ticket/5175#t31080 XML driver for contacts Tue, 03 Apr 2007 03:22:27 -0400 http://bugs.horde.org/ticket/5175#t31081 New Kolb driver for mnemo Tue, 03 Apr 2007 03:23:04 -0400 http://bugs.horde.org/ticket/5175#t31082 New Kolab driver for nag Tue, 03 Apr 2007 03:23:50 -0400 http://bugs.horde.org/ticket/5175#t31083 New Kolab driver for turba Tue, 03 Apr 2007 03:24:23 -0400 http://bugs.horde.org/ticket/5175#t31084 Hm, I believe the currently suggested organization would actually introduce a structural problem. The XML drivers are strongly coupled to the respective kolab.php drivers within the different applications (note.php with mnemo, task.php with nag, etc.) Once we would later change something within note.php we might also need to adapt the mnemo kolab driver. While this would probably not happen very often, I assume we would break backward compatibility in that case. I simply did not think about this before - still not deep enough in the Horde structure, but I'm trying to improve :) Anyhow I assume the better solution would be to put the note.php part directly into the respective kolab.php drivers. Is that correct? Wed, 04 Apr 2007 17:32:28 -0400 http://bugs.horde.org/ticket/5175#t31109 > The XML drivers are strongly coupled to the respective kolab.php > drivers within the different applications (note.php with mnemo, > task.php with nag, etc.) Once we would later change something within > note.php we might also need to adapt the mnemo kolab driver. While > this would probably not happen very often, I assume we would break > backward compatibility in that case. > > I simply did not think about this before - still not deep enough in > the Horde structure, but I'm trying to improve :) > > Anyhow I assume the better solution would be to put the note.php part > directly into the respective kolab.php drivers. Is that correct? That sounds right to me, yes. Mon, 09 Apr 2007 17:32:19 -0400 http://bugs.horde.org/ticket/5175#t31325 Hello Chuck, >> Anyhow I assume the better solution would be to put the note.php part >> directly into the respective kolab.php drivers. Is that correct? > > That sounds right to me, yes. Ok. Let's assume we need some major changes in XML.php, how would that be done? Only with Horde 4.0? I can imagine once the new Kolab code is in place and put into production the first time, the need for changes will arise or at least we should have the possibility to do so. Though I hope the code is bug free ;-) Cheers, Thomas Wed, 11 Apr 2007 08:21:21 -0400 http://bugs.horde.org/ticket/5175#t31410 Ideally for 4.0, we'll finally separate the horde version from individual framework package versions, so that the applications can simply up the version of the Kolab package that they require. Wed, 11 Apr 2007 13:17:07 -0400 http://bugs.horde.org/ticket/5175#t31438 We continued discussion on this and it seems the best solution is to keep the structure as suggested by the current patches. We will have to define one interface that has to be kept stable anyhow. Either this will be on the level of the array that is being transferred between the specific Kolab XML handler (e.g. note.php or task.php) and the application. Or it is on the level of the XML.php handler that would be used within each application. There are two reasons why the first solution might be better: The XML handling resides fully within the Kolab module. Thus it is also available to other PHP applications that would use the Horde Framework modules as a library. In addition the XML.php interface would be binding for all four applications we are currently targeting. Specifying the transferred array is something we do per application. Since it is important to get the interface right the first time we commit it, we will still wait with this until the kronolith Kolab driver has also been converted to the new structure. Wed, 18 Apr 2007 11:44:39 -0400 http://bugs.horde.org/ticket/5175#t31820 In CVS. Fri, 25 May 2007 10:24:03 -0400 http://bugs.horde.org/ticket/5175#t33483