Difference between revisions of "Frameworks/Epics/kdepimlibs"

Jump to: navigation, search
(Split Tasks: In-depth break-down of kdepim libraries)
Line 321: Line 321:
 
|- {{ FrameworkDone | syndication |  |  |  | }}
 
|- {{ FrameworkDone | syndication |  |  |  | }}
 
|}
 
|}
 +
 +
==== kdepim Tasks ====
 +
 +
{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width:100%;"
 +
|- style="background: #ececec; white-space:nowrap;"
 +
! Status
 +
! Framework
 +
! Tier
 +
! width=120 | Assigned
 +
! Priority
 +
! Action Required / Notes
 +
|- {{ FrameworkTodo | calendarsupport | | | | }}
 +
|- {{ FrameworkTodo | composereditor-ng | | | |  }}
 +
|- {{ FrameworkTodo | eventviews | | | | Merge with calendarsupport? }}
 +
|- {{ FrameworkTodo | grantleeeditor | | | | Standalone Grantlee template IDE? }}
 +
|- {{ FrameworkTodo | grantleetheme | | | | Grantlee theme (template sets) manager API. Could maybe be replaced by KPackage? }}
 +
|- {{ FrameworkTodo | incidenceeditor-ng | | | | }}
 +
|- {{ FrameworkTodo | kaddressbookgrantlee | | | | ??? }}
 +
|- {{ FrameworkTodo | kdgantt2 | Tier 2 | | | Might need some cleanup/polish work, but basically ready }}
 +
|- {{ FrameworkTodo | libfollowupreminder | | | | Why is this a library? }}
 +
|- {{ FrameworkTodo | libkdepim/addressline | | | | Smart KLineEdit that autocompletes emails from addressbook and PIM Search, includes configuration dialog  }}
 +
|- {{ FrameworkTodo | libkdepim/job | | | | Adding contacts to addressbook, whitelisting addresses to show HTML/images by default. KMail specific? }}
 +
|- {{ FrameworkTodo | libkdepim/ldap | | | | LDAP KCM + search job -> move to KLDAP framework? }}
 +
|- {{ FrameworkTodo | libkdepim/misc/broadcaststatus.cpp | | | | Singleton to allow creating status notifications (in app statusbar) from any code, apps can listen to it. Used only by KMail }}
 +
|- {{ FrameworkTodo | libkdepim/misc/emailvalidator.cpp | | | | QValidator for email addresses. Depends on KEmailAddress from KCodecs }}
 +
|-{{ FrameworkTodo | libkdepim/misc/kcursorsaver.h | | | | RAII helper for temporarily changing mouse cursor. KWidgetAddons? }}
 +
|-{{ FrameworkTodo | libkdepim/misc/maillistdrag.cpp | | | | Drag&drop code for emails (??) }}
 +
|-{{ FrameworkTodo | libkdepim/misc/uistatesaver.cpp | | | | Store/restore state of QSplitter, QTabWidget, QTreeView or QComboBox widgets in a config file }}
 +
|- {{ FrameworkTodo | libkdepim/multiplyingline | | | | Auto-adds new widget row when you start filling the last one. Clear KWidgetsAddons candidate }}
 +
|- {{ FrameworkTodo | libkdepim/kprefs | | | | Looks like something KConfigXT can do today, but probably predates it a bit ( (c) 2001 by Cornelius), could be killed? Used heavily by KOrganizer and little by Kontact (probably due to KOrganizer) }}
 +
|- {{ FrameworkTodo | libkdepim/progresswidget | | | | KWidgetsAddons candidate, advances progress/tasks reporting, has Akonadi::AgentManager to show resource tasks progress }}
 +
|- {{ FrameworkTodo | libkdepim/proxy | | | | KColumnFilterProxyModel is a candidate for KItemModels framework,  QuotaColorProxyModel has Akonadi dependency, could be moved to libakonadi }}
 +
|- {{ FrameworkTodo | libkdepim/widget | | | | Random widgets, some could go to KWidgetsAddons, some candidates for KPimWidgets? }}
 +
|- {{ FrameworkTodo | libkdepimdbusinterfaces | | | | KOrganizer DBus interfaces (.xml) + some . Why is it even a stanadlone library? }}
 +
|- {{ FrameworkTodo | libkleo | | | | -> KF5Kleo (-> KF5Crypto? :)) }}
 +
|- {{ FrameworkTodo | libksieve | | | | Sieve interaction library + Sieve widgets, split to Sieve Framework (like KIMAP), move most of the widgets to Sieve IDE, keep only those used directly from KMail? }}
 +
|- {{ FrameworkTodo | libsendlater | | | | Why is this even a library? }}
 +
|- {{ FrameworkTodo | mailcommon | | | | }}
 +
|- {{ FrameworkTodo | mailcommon/filter | | | | Local mail filters }}
 +
|- {{ FrameworkTodo | mailcommon/collectionpage | | | | Collection properties dialog pages -> move to Akonadi? }}
 +
|- {{ FrameworkTodo | mailcommon/folder | | | | Mail folders abstraction and glue-code between the abstraction and Akonadi collections }}
 +
|- {{ FrameworkTodo | mailcommon/job | | | | Random folder-related jobs }}
 +
|- {{ FrameworkTodo | mailcommon/search | | | | Widgets and some logic for the big Search dialog }}
 +
|- {{ FrameworkTodo | mailcommon/snippets | | | | ?? }}
 +
|- {{ FrameworkTodo | mailcommon/tags | | | | Akonadi Tag abstraction. There are some tag widgets in libkdepim too. Merge? }}
 +
|- {{ FrameworkTodo | mailcommon/widget | | | | Random widgets }}
 +
|- {{ FrameworkTodo | mailcommon/mdn | | | | SendMDNHandler <- merge to KMail? }}
 +
|- {{ FrameworkTodo | mailcommon/util | | |  | mailutil.h - random helper functions }}
 +
|- {{ FrameworkTodo | mailcommon/kernel | | | |  The Kernel singleton that unifies access to various interfaces }}
 +
|- {{ FrameworkTodo | mailimporter | | | | }}
 +
|- {{ FrameworkTodo | mboximporter | | | | Merge with mailimporter? }}
 +
|- {{ FrameworkTodo | messagecomposer | | | | email composer and tons of helper code and utilities }}
 +
|- {{ FrameworkTodo | messagecore | | | | }}
 +
|- {{ FrameworkTodo | messagecore/attachment | | | | Attachment handling code; merge with messagecomposer/attachment? }}
 +
|- {{ FrameworkTodo | messagecore/misc/imagecollector.cpp | | | | Collects images from email; could be part of the new OTP? }]
 +
|- {{ FrameworkTodo | messagecore/misc/mailinglist.cpp | | | | Extracts ML information from emails }}
 +
|- {{ FrameworkTodo | messagecore/misc/mdnstateattribute.cpp | | | | Why is this not in mailcommon/mdn? }}
 +
|- {{ FrameworkTodo | messagecore/settings | | | | KCFG file; seems to contain Reader and Composer settings. Kill? }}
 +
|- {{ FrameworkTodo | messagecore/util | | | | String-handling utilities, some deprecated }}
 +
|- {{ FrameworkTodo | messagelist | | | | The entire messagelist pane from KMail, Akonadi-specific implementation of the abstract MessageList::Core::StorageModel (flatten the abstraction??) }}
 +
|- {{ FrameworkTodo | messagelist/core | | | | The Model, View, themes and delegates }}
 +
|- {{ FrameworkTodo | messagelist/utils | | | | Configuration dialogs for aggregation, threading and themes }}
 +
|- {{ FrameworkTodo | messageviewer | | | | }}
 +
|- {{ FrameworkTodo | messageviewer/a11y | | | | A11y for viewer, does not really look like it works (the implementation is mostly empty }}
 +
|- {{ FrameworkTodo | messageviewer/adblock | | | | Pretty complete adblock for emails. Make it a plugin? }}
 +
|- {{ FrameworkTodo | messageviewer/antispam | | | | Read antispam mail headers and shows the results in UI + some configuration. Could be OTP part/plugin? }}
 +
|- {{ FrameworkTodo | messageviewer/findbar | | | | Search bar for the webview }}
 +
|- {{ FrameworkTodo | messageviewer/grantleefilters | | | | Mail-specific Grantlee template filters }}
 +
|- {{ FrameworkTodo | messageviewer/gravatar | | | | Fetch sender's face from interwebs }}
 +
|- {{ FrameworkTodo | messageviewer/header | | | | Mail header styles }}
 +
|- {{ FrameworkTodo | messageviewer/htmlwriter  | | | | Dump rendered email HTML to file? }}
 +
|- {{ FrameworkTodo | messageviewer/interfaces | | | | OTP interfaces? }}
 +
|- {{ FrameworkTodo | messageviewer/job | | | | Attachment, Kleo, Mail-to-event/note jobs }}
 +
|- {{ FrameworkTodo | messageviewer/notify | | | | Get KNotifications when new adblock list is available :-O }}
 +
|- {{ FrameworkTodo | messageviewer/scamdetection | | | | Detect possible scam mails using different heuristics. Could be OTP part/plugin, like antispam and adblock? }}
 +
|- {{ FrameworkTodo | messageviewer/themes | | | |  Grantlee themes examples }}
 +
|- {{ FrameworkTodo | messageviewer/viewer | | | |  The Viewer + OTP }}
 +
|- {{ FrameworkTodo | messageviewer/viewerplugins | | | | Good start on viewer plugins, few default plugins }}
 +
|- {{ FrameworkTodo | messageviewer/widgets | | | | }}
 +
|- {{ FrameworkTodo | noteshared | | | | Share Notes via local network (?) }}
 +
|- {{ FrameworkTodo | pimcommon/acl | | | | Collection ACL settings/widgets. Move to mailcommon/collectionpage? }}
 +
|- {{ FrameworkTodo | pimcommon/autocorrection | | | | Use Sonnet instead? Used in composer only }}
 +
|- {{ FrameworkTodo | pimcommon/baloodebug | | | | Move to PIM Search, rename }}
 +
|- {{ FrameworkTodo | pimcommon/customtools | | | | Interface for custom (composer?) plugins, shorturl and translator plugins, move to composer? }}
 +
|- {{ FrameworkTodo | pimcommon/gravatar | | | | Merge with messageviewer/gravatar }}
 +
|- {{ FrameworkTodo | pimcommon/manageserversidesubscription | | | | Dialog to mange server-side subscription - IMAP/Kolab specific, should be moved to the resources? }}
 +
|- {{ FrameworkTodo | pimcommon/migration | | | | Migrate app config and data files for KDE4->KF5?  }}
 +
|- {{ FrameworkTodo | pimcommon/settings | | | | KCFG for individual submodules, IMO each submodule should have its own settings }}
 +
|- {{ FrameworkTodo | pimcommon/shareserviceurlmanager | | | | KPurpose/KSocial/KIPI/standalone framework? }}
 +
|- {{ FrameworkTodo | pimcommon/shorturl | | | | Configure and talk to URL shortener services. KPurpose/KIPI candidate, or  a standalone framework? }}
 +
|- {{ FrameworkTodo | pimcommon/sievehighlighter | | | | Why is this not part of libksieve? }}
 +
|- {{ FrameworkTodo | pimcommon/storageservice | | | | Our own Dolphin :) Talk to KPurpose/KIPI and merge it there, or create a standalone framework for remote storage access }}
 +
|- {{ FrameworkTodo | pimcommon/templatewidgets | | | | Probably mail templates? Move to mailcommon then }}
 +
|- {{ FrameworkTodo | pimcommon/temporaryfile | | | | Create temporary dir for opening attachments. mailcommon/mailviewer? }}
 +
|- {{ FrameworkTodo | pimcommon/texteditor | | | | Our very own Kate :-). Kill and use KTextEdit? }}
 +
|- {{ FrameworkTodo | pimcommon/texttospeech | | | | TTS abstraction (currently hardcodes unreleased QTextToSpeech). Do we even need an abstraction (once QTTS is released) }}
 +
|- {{ FrameworkTodo | pimcommon/translator | | | | Talks to Google Translate to translate your emails. GT does not have an API, so not a good candidate for KGAPI, but could be merged to the translate plugin that lives somewhere in messageviewer or mailcommon? }}
 +
|- {{ FrameworkTodo | pimcommon/util | | | | .... }}
 +
|- {{ FrameworkTodo | pimcommon/util/createresource.cpp | | | | Synchronously create an Akonadi resource + error handling. Move to AgentManager? }}
 +
|- {{ FrameworkTodo | pimcommon/util/editorutil.cpp | | | | }}
 +
|- {{ FrameworkTodo | pimcommon/util/imapresourcecapabilitiesmanager.cpp | | | | Queries IMAP server capabilities via DBus (by talking to the resource }}
 +
|- {{ FrameworkTodo | pimcommon/util/networkutil.cpp | | | | Singleton that holds if low-bandwidth mode is enabled }}
 +
|- {{ FrameworkTodo | pimcommon/util/pimutil.cpp | | | | Random stuff }}
 +
|- {{ FrameworkTodo | pimcommon/util/vcardutil.cpp | | | | Replaces X-messaging/FOO-All by X-FOO in raw vcard ??? }}
 +
|- {{ FrameworkTodo | pimcommon/webshortcut | | | | Gain access to webshortcuts configured in webshortcuts KCM }}
 +
|- {{ FrameworkTodo | pimcommon/widgets | | | | .... }}
 +
|- {{ FrameworkTodo | pimcommon/widgets/annotationdialog.cpp | | | | Create item notes (annotations) }}
 +
|- {{ FrameworkTodo | pimcommon/widgets/configureimmutablewidgetutils.cpp | | | | Something that should go to KConfig(Widgets) }}
 +
|- {{ FrameworkTodo | pimcommon/widgets/customtextedit.cpp | | | | In case the 2 editors in pimcommon/texteditor are not enough }}
 +
|- {{ FrameworkTodo | pimcommon/widgets/customtreeview.cpp | | | | QTreeView that can show a centered text when it's empty }}
 +
|- {{ FrameworkTodo | pimcommon/widgets/emailaddressrequester.cpp | | | | KLineEdit with button to choose contact from address book }}
 +
|- {{ FrameworkTodo | pimcommon/widgets/kactionmenuchangecase.cpp | | | | creates KActions to change convert word or sentece to lower/upper case. How is this even useful? :D }}
 +
|- {{ FrameworkTodo | pimcommon/widget/lineeditwidgetcompleter.cpp | | | | KLineEdit with special context-menu action to clear its KCompletion history }}
 +
|- {{ FrameworkTodo | pimcommon/widget/manageaccountwidget.cpp | | | | Add/remove/configure Akonadi resources widget. Move to libakonadi }}
 +
|- {{ FrameworkTodo | pimcommon/widget/minimumcombobox.cpp | | | | Literally a tiny KComboBox }}
 +
|- {{ FrameworkTodo | pimcommon/widget/renamefiledialog.cpp | | | | }}
 +
|- {{ FrameworkTodo | pimcommon/widget/simplestringlisteditor.cpp | | | | QDialog to add/modify/remove/reorder list of strings.  -> KWidgetAddons?  }}
 +
|- {{ FrameworkTodo | pimcommon/widget/slidecontainer.cpp | | | | A hidden-by-default widget that slides in when shown. Do we even need this fancy stuff? }}
 +
|- {{ FrameworkTodo | pimcommon/widget/spellchecklineedit.cpp | | | | PimCommon::RichTextEdit with magical powers }}
 +
|- {{ FrameworkTodo | sieveeditor | | | | Sieve IDE }}
 +
|- {{ FrameworkTodo | storageservicemanager | | | | Our own Dolphin, part 2 }}
 +
|- {{ FrameworkTodo | templateparser | | | | Message templates (reply/forward/... templates) parser, editor and manager }}

Revision as of 13:54, 2 October 2015

kdepimlibs Epic

Status

Status as at 31 Januray 2015.

  • Akonadi supports Qt 5 since release 1.11
  • All kdepim has CMake automoc
  • Most of the kdepimlibs subdirs are now building using ECM.
  • Porting the kdepim libraries to KF5/Qt5 started (A big porting is port to QLocale)
  • Maintainers are requested to fill in the Code Units grid below
  • kdepimlibs is split in several modules.
  • Some modules were renames : KABC->KContacts, kpimidentity->kidentitymanagement etc.
  • KPimUtils was removed (merge in kf5)

Planning

At the KDE PIM sprint the following plan was discussed on the assumption that no work had been started yet, so it was better to wait until the kdelibs split had been performed:

  • Wait for the kdelibs split to be completed and the preview release to be made
  • A frameworks branch to be created in kdepimlibs
  • All obsolete libraries to be deleted
  • Qt5 / KF5 basic porting to be performed mostly by the Frameworks team (old frameworks branch to be reviewed and deleted)
  • Once work is started here no more style fixes to be applied to Master
  • Code relying on qt3support and deprecated libraries will be removed as part of the porting
  • All classes to be reviewed by key maintainers to decide if any should move elsewhere
  • Once basic porting is completed then kdepimlibs will be spilt into separate frameworks
  • Once split the maintainers of each framework will take over work to make any API and code changes required
  • PIM Frameworks will be released as and when they are ready, we do not need to release them all at the same time
  • PIM Frameworks will be prioritised depending on usage, i.e. libraries needed by KDE Workspaces and Kolab should be released first
  • kdepim-runtime will be split between PIM Framework and kdepim


Since then Stephen Kelly has advised he has already completed significant parts of the port and is recommending the following plan be followed:

  • Clean-up in Master branch
    • Port away from obsolete code
    • Includes
    • Q_SLOTS and Q_SIGNALS
    • kde4_add_library -> add_library
  • Merge to frameworks
  • Delete obsolete code from frameworks branch
  • Port to Qt5 / KF5
    • Adapt to upstream api changes, includes, cmake, etc
    • Use kde4support as required
  • Remove use of kde4support
  • Code rearranging
    • Internal library splits, merges
  • Code improvements
    • API changes
    • Refactoring
  • Coding Style fix
  • Split
  • Release

Policies

See the other Frameworks pages for the KDE Frameworks Policies, the kdelibs Split Policies and the Definition of Done .

The kdepimlibs specific policies are:

  • Modules that use qt3support are to be removed
  • Deprecated API is allowed to be removed
  • Source compatibility requirements are relaxed due to fewer clients, but major rewrites are discouraged. Instead port the old library and create a separate new library (e.g. KHolidays and QHolidays).
  • Most libraries will aim for Tier 2, but some may be able to target Tier 1.
  • The initial KF5 port may rely on kde4support to enable the port to be performed by non-experts, but no Framework released may rely on kde4support so the maintainer must remove all usage. In particular all KDateTime, KTimeZone and KLocale usage must be removed and the Qt replacements throughly tested for regressions and behaviour changes.

Priorities

The following libraries are known to be used outside of KDE PIM and so may be a higher priority in porting.

For Plasma support the decision has been made to deprecate the use of DataEngines and use QML includes instead.

Priority items:

  • Akonadi
  • KABC
  • KCalCore
  • KMime
  • KHolidays
  • QGpgme
  • KXMLRPCClient
  • + other Kolab libs

kde-workspace

Usage:

  • kde-workspace/libs/plasmaclock/
    • KHolidays (for selection widget, could be moved elsewhere?)
    • CalendarEngine
  • kde-workspace/plasma/generic/dataengines/akonadi/
    • Akonadi
    • KMime
    • KABC
    • Microblog
    • KPimUtils (linked but not included?)
    • AkonadiEngine not used anywhere
  • kde-workspace/plasma/generic/dataengines/calendar/
    • Akonadi
    • KCalCore
    • KCalUtils
    • KHolidays
    • CalendarEngine only used in kde-workspace/libs/plasmaclock/
  • kde-workspace/plasma/generic/dataengines/rss/
    • Syndication


Note: It is recommended that the Akonadi DataEngine be reworked/renamed as EMailEngine, ToDoEngine, etc, as this is client developer facing API and so the implementation name should be abstracted/hidden from them, i.e. as is done with the CalendarEngine.

kde-runtime

Usage:

  • kde-runtime/drkonqi/
    • KXMLRPCClient
  • kde-runtime/kwalletd
    • QGpgme

kdeplasma-addons

Usages:

  • kdeplasma-addons/libs/lancelot-datamodel
    • Akonadi - for email support
  • kdeplasma-addons/runners/contacts
    • Akonadi
    • KABC
  • kdeplasma-addons/runners/events
    • Akonadi
    • KCalCore
  • kdeplasma-addons/applets/news/
    • RssEngine
  • kdeplasma-addons/applets/rssnow/
    • RssEngine


Runners could be converted to either use KPeople, or to use the QML includes? Or the DataEngines?

Kolab

Basically most of the lower-level libraries and kdelibs(kdecore)!

Dependencies of libkolab:

  • KIMAP
  • KABC
  • KCalCore
  • KMime
  • KCalUtils (only for invitation formatting, incidenceformatter.h/stringify.h)
  • KPimUtils (only for email parsing, email.h)
  • akonadi/notes (note wrapper around KMime message)
  • kdelibs (KDateTime, jobs and dependencies of kdepimlibs)

Since libkolab is used on the server, all it's dependencies shouldn't have GUI/DBUS/runtime-deamon dependencies.

Code Units

The following is a high-level list of the different Code Units in kdepimlibs and kdepim-runtime. A Unit may be a library or other software artefact that is to be considered as a stand-alone unit of code.

Initial listing of top-level directories and the README and MAINTAINERS files. If subdirectories need breaking out separately then please add to list.

Note that the status listed in this table is solely whether the information required has been completed, not that theport has been completed.

kdepimlibs

Status Unit Description Maintainer Dependencies External Usage
IN PROGRESS akonadi Client access library for using the Akonadi PIM data server. Dan Vratil KJob, KDialog, KDebug, KLocale, KMimeType, Ki18n, KIcon, KPixmapSequence, KComboBox, KLineEdit, KStandardShortcut, KItemModels/Views, KXmlGui, KApp/KCD/KCmdLineArgs, KPimUtils, KAction, KConfig, KStandardDirs, misc K* widgets, KColorScheme, KIO, KTextBrowser, KDateTime, Solid, KGlobal::ref, KInputDialog, KMessageBox, KProcess, KRun, KUser, KFileDialog, KPluginLoader, KRandom, KMime (tests only)
IN PROGRESS akonadi/calendar Calendar-specific Akonadi client library Akonadi, Akonadi Contacts, Akonadi KMime, Mailtransport, KCalCore, KCalUtils, Mailtransport, Ki18n, KLocale, KDateTime, KTimeZone, KJob, KPimIdentities, KEmailSettings, KIO, KTemporaryFile, KMessageBox, various K widgets, KStandardDirs, KIcon, KItemModels, KPimUtils
IN PROGRESS akonadi/contacts Contact-specific Akonadi client library Akonadi, KABC, Ki18n, KLocale, KConfig, KStandarddirs, KJob, KIO (incl. NetAccess), KStringHandler, KDialog, KPluginFactory/Info, various K widgets, KIcon, KMessageBox, KToolInvocation, KRun, KDebug, KAction, KColorSchme, KTextBrowser/Edit, KDatePicker, KPixmapRegionSelectorDialog, KFileDialog, KAccelManager, KPimUtils, KApp/KCD/KCmdLineArgs (tests only), KCalCore, KMime, KCM, KAboutData (kcm and tests only), Nepomuk2 Core, Phonon
TODO akonadi/kabc what's the difference to the above? none!?
DONE akonadi/kcal KCal-specific Akonadi client library (deprecated?) to be deleted
IN PROGRESS akonadi/kmime Mail-specific Akonadi client library Akonadi, KMime, Ki18n, KDebug, KMessageBox, KIO, KAction, KIcon, KLocale, KApp/KCD/KCmdLineArgs (tests only)
IN PROGRESS akonadi/notes Notes-specific Akonadi client library Akonadi, KMime, KDateTime, KDebug, Ki18n
IN PROGRESS akonadi/socialutils Social media Akonadi client library Akonadi, KIO, QJson, KImageCache, KDebug, KDateTime
DONE cmake N/A
TODO docs KDoctools
IN PROGRESS gpgme++ C++ API for libgpgme Marc Mutz no Qt/KDE
DONE includes Camel case forwarding headers
DONE kabc Tobias koenig KLocale, Ki18n, KStandardDirs, KCD, KRandom, KConfig*, KMessageBox, KCodec, KDialog (? KRes removal ifdef seems not strict enough), KMimeType, KApplication & friends (tests only)
IN PROGRESS kalarmcal David Jarvie KCalCore, KHolidays, Akonadi, KLocale, KTimeZone, Ki18n, KDebug, KPimIdentities, KMessageBox, KDateTime, KConfig
IN PROGRESS kblog C++ API for weblogging access Christian Weilbach KDebug, KDateTime, KTimeZone, KXmlRpcClient, KIO, KCal, Ki18n, KStandardDirs
DONE kcal C++ API for the iCalendar and vCalendar formats (Deprecated by kcalcore and kcalutils) Sergio Martins, Allen Winter to be removed
IN PROGRESS kcalcore C++ API for the iCalendar and vCalendar formats Sergio Martins, Allen Winter KDebug, KDateTime, KTimeZone, KCodecs, KRandom, KConfig, K[Temp,Save]File, KMimeType, KStandardDirs, KApp/KCD/KCmdLine (tests only)
IN PROGRESS kcalutils C++ library containing utility functions on top of kcalcore. Sergio Martins, Allen Winter kcalcore, kpimidentities, ki18n, kpimutils, KDialog, KDebug, KMimeType, KTimeZone, KDateTime, KCalendarSystem, KIconLoader, KMessageBox, KLocale
DONE kholidays C++ library for calendar holidays John Layt, Allen Winter kdeui, kio ( KComboBox, KStandardDirs, KCalendarSystem, KLocale, KLocalizedString) Plasma, KMyMoney
IN PROGRESS kimap C++ API for IMAP support Christian Mollekopf KMime, KDebug, K1i8n, KTcpSocket, KIO/SSL, KJob, KCD/KAboutData (tests only)
DONE kioslaves/imap4 imap4 kioslave to be removed
DONE kioslaves/ldap ldap kioslave Ki18n, KIO, KDebug, KCD, KLDAP
DONE kioslaves/mbox mbox kioslave Ki18n, KIO, KDebug, KCD
DONE kioslaves/nntp nntp kioslave Ki18n, KIO, KDebug, KCD
DONE kioslaves/pop3 pop3 kioslave Ki18n, KIO, KDebug, KCD, KMD5, SASL2
DONE kioslaves/sieve Sieve kioslave Ki18n, KIO, KDebug, KCD, KMessageBox, SASL2
DONE kioslaves/smtp smtp kioslave Ki18n, KIO, KDebug, KCD, SASL2, KEmailSettings
DONE kldap C++ API for LDAP access Szombathelyi György KDebug, Ki18n, KProgressDialog, KLineEdit, KMessageBox, KComboBox
DONE kmbox Bertjan Broeksema KMime, KStandardDirs, KDebug, KTempDir (tests only)
IN PROGRESS kmime C++ API for MIME handling Volker Krause, Marc Mutz KCharsets, KLocale, KDateTime, KCalendarSystem, KDebug, KAscii, kpimutils (header-only), KCD (tests only), Ki18n
IN PROGRESS kontactinterface The glue for embedding KParts into Kontact Allen Winter KPlugin, KXmlGui, some K widgets, KDialog, KPimUtils, K[Unique]Applications/KCmdLineArgs, KWindowSystem, KParts, KAboutData, KCD, KStandardDirs, KRun, KDebug, KGlobalSettings, KIcon*, KStartupInfo, KLocale
IN PROGRESS kpimidentities C++ API for shared identities for mail applications KPimUtils, KEmailSettings, KConfig*, KUser, KRandom, Ki18n, various K* widgets, KDebug, KProcess, KMessagebox, KRichTextEdit, KIcon*, KShellCompletion, KPimTextEdit, Sonnet
IN PROGRESS kpimtextedit Provides a textedit with PIM-specific features and can convert the textedit content to various markup formats Thomas McGuire, Stephen Kelly KImageIO, KFileDialog, KDialog, KAction*, KRichtextEdit, KIcon*, KCharSelect, KI18n, KStdDirs, various K widgets, KEmoticons, KMime, Sonnet, KCursor
IN PROGRESS kpimutils A library for general purpose PIM utilities KMessageBox, KStdGuiItem, KI18n, KDebug, KURL, KMime (yay, cyclic dependency!), KEmoticons, KPixmapSequence
DONE kresources Tobias Koenig to be removed
IN PROGRESS ktnef C++ API for the handling of TNEF data Michael Goffioul KPimUtils, KCalCore, KABC, Ki18n, KDateTime, KMimeType, KSaveFile, KDebug
DONE kxmlrpclient An XML-RPC client library KIO, KDebug, Ki18n
IN PROGRESS mailtransport C++ API and support code for managing mail transport Ki18n, KDebug, KDialog, KJob, KStringHandler, KMime, Akonadi, KStdDirs, KMessageBox, some K widgets, KIO, KApp/KCD/KCmdLineArgs (tests only), KWallet, KConfig, KEmailSettings, KRandom, Akonadi KMime, KCM/KPlugin* (KCM only), KTcpSocket/SASL (no-KIO mode)
DONE microblog A library for microblogging Tom Albers KDebug, KPimUtils
IN PROGRESS qgpgme A C++ wrapper for gpgme Marc Mutz QtCore only
IN PROGRESS syndication An RSS/Atom feed parser library Frank Osterfeld KIO, KCharset, KDateTime, KDebug, Kapp/Kcmdlineargs/KCD (tests only), KRandom, KProcess

kdepim-runtime

Status Unit Description Maintainer Dependencies External Usage
TODO accountwizard Generic account setup wizard framework - how does this relate to WebAccounts? Kross, Akonadi, Mailtransport, KPimIdentities, QtUiTools, KNewStuff3, KConfig, KMime, KIO, K[Unique]App/KCD/KCmdLineArgs, KAboutData, KMessageBox, KAssistantDialog, KPageWidget*, KDebug, KLocale, Ki18n, KStringHandler, KDebug, KWallet, KPimUtils, KMimeType, KDesktopFile
TODO agents/invitations Map iTip invitations to a calendar
TODO agents/maildispatcher Mail sending
TODO agents/migration Migration agent
TODO agents/nemailnotifier New Mail Notfications
TODO cmake
TODO defaultsetup Akonadi
TODO doc
TODO kcm
TODO kioslave Akonadi KIO integration
TODO kresources Akonadi KResources Kevin Krammer to be removed
TODO libkdepim-copy
TODO migration Plug-ins for the migration agent, and other migration tools
TODO opensync
TODO plugins Serializer Plugins
TODO qml
TODO resources/agentserver
TODO resources/birthdays Birthday Resources
TODO resources/contacts Local Addressbook Tobias König
TODO resources/facebook Facebook Resource Martin Klapetek
TODO resources/ical iCal File Resource
TODO resources/imap IMAP Resource Christian Mollekopf
DONE resources/kabc KABC KRes Resource Kevin Krammer to be removed
DONE resources/kcal KCal KRes Resource Kevin Krammer to be removed
TODO resources/kolabproxy Kolab Resource Christian Mollekopf
TODO resources/maildir Maildir Resource Andras Mantia
TODO resources/mixedmaildir KMail1 legacy resource
TODO resources/nntp NNTP Resource
TODO resources/pop3 POP3 Resource Thomas McGuire
TODO resources/vcard VCard file resource
TODO resources/akonotes
TODO resources/dav
TODO resources/google Martin Klapetek
TODO resources/icaldir
TODO resources/kalarm David Jarvie
TODO resources/kdeaccounts
TODO resources/localbookmarks
TODO resources/mailtransport_dummy Mailtransport Unit Test Resource (move to mailtransport?)
TODO resources/mbox MBox file resource
TODO resources/nepomuktag Tag folders
TODO resources/openxchange
TODO resources/shared
TODO resources/vcarddir
TODO resourcetester
DONE tray Akonadi Tray kill

Split Tasks

kdepimlibs Tasks

Status Framework Tier Assigned Priority Action Required
TODO akonadi merge with akonadi server?
TODO akonadi/calendar Tier 3?
TODO akonadi/contacts Tier 3?
TODO akonadi/kabc Tier 3? merge to akonadi/contacts? Only defines 2 aliases for payload parts and is only used by akonadi_serializer_addressee, but I've never seen such part names in my Akonadi. Maybe it could even be deleted?
DONE akonadi/kcal N/A deprecated - delete
TODO akonadi/kmime Tier 3?
TODO akonadi/notes Tier 3?
TODO akonadi/socialutils Tier 3?
DONE cmake N/A FindLDAP: move to kldap, FindQgpgme: obsolete by config file, FindGpgme: move to gpgme++, FindQJSon: obsolete, already upstream, FindQtOAuth: ?, CheckTimezones: ? FindLibical: move to kcalcore, FindXsltproc: rename and move to Akonadi
DONE doc KRES KCM: obsolete, KIOslave docs: move to slaves
TODO gpgme++
DONE includes N/A distribute to splitted modules, auto-generate?
DONE kabc remove KResource dependencies
DONE kalarmcal remove optional KCal dependency
TODO kblog port to KCalCore
DONE kcal N/A To be deleted
TODO kcalcore High (Workspace)
TODO kcalutils High (Workspace)
TODO kholidays Tier 1 High (Workspace) Split as is and clean-up api. Will be replaced later by OpenHolidays. Will need internal copy of QCalendarSystem, Gui uses KComboBox. Replace KStandardDirs?
TODO kimap
DONE kioslave/imap4 N/A To be deleted
DONE kioslave/ldap
DONE kioslave/mbox
DONE kioslave/nntp
DONE kioslave/pop3
DONE kioslave/sieve
DONE kioslave/smtp
TODO kldap
TODO kmbox
TODO kmime
TODO kontactinterface
TODO kidentitymanager
TODO kpimtextedit
DONE kpimutils remoded
DONE kresources N/A deleted
DONE ktnef remove KCal dependency
DONE kxmlrpcclient
TODO mailtransport
TODO microblog obsolete after microblog resource removal?
DONE qgpgme
DONE syndication

kdepim Tasks

Status Framework Tier Assigned Priority Action Required / Notes
TODO calendarsupport
TODO composereditor-ng
TODO eventviews Merge with calendarsupport?
TODO grantleeeditor Standalone Grantlee template IDE?
TODO grantleetheme Grantlee theme (template sets) manager API. Could maybe be replaced by KPackage?
TODO incidenceeditor-ng
TODO kaddressbookgrantlee ???
TODO kdgantt2 Tier 2 Might need some cleanup/polish work, but basically ready
TODO libfollowupreminder Why is this a library?
TODO libkdepim/addressline Smart KLineEdit that autocompletes emails from addressbook and PIM Search, includes configuration dialog
TODO libkdepim/job Adding contacts to addressbook, whitelisting addresses to show HTML/images by default. KMail specific?
TODO libkdepim/ldap LDAP KCM + search job -> move to KLDAP framework?
TODO libkdepim/misc/broadcaststatus.cpp Singleton to allow creating status notifications (in app statusbar) from any code, apps can listen to it. Used only by KMail
TODO libkdepim/misc/emailvalidator.cpp QValidator for email addresses. Depends on KEmailAddress from KCodecs
TODO libkdepim/misc/kcursorsaver.h RAII helper for temporarily changing mouse cursor. KWidgetAddons?
TODO libkdepim/misc/maillistdrag.cpp Drag&drop code for emails (??)
TODO libkdepim/misc/uistatesaver.cpp Store/restore state of QSplitter, QTabWidget, QTreeView or QComboBox widgets in a config file
TODO libkdepim/multiplyingline Auto-adds new widget row when you start filling the last one. Clear KWidgetsAddons candidate
TODO libkdepim/kprefs Looks like something KConfigXT can do today, but probably predates it a bit ( (c) 2001 by Cornelius), could be killed? Used heavily by KOrganizer and little by Kontact (probably due to KOrganizer)
TODO libkdepim/progresswidget KWidgetsAddons candidate, advances progress/tasks reporting, has Akonadi::AgentManager to show resource tasks progress
TODO libkdepim/proxy KColumnFilterProxyModel is a candidate for KItemModels framework, QuotaColorProxyModel has Akonadi dependency, could be moved to libakonadi
TODO libkdepim/widget Random widgets, some could go to KWidgetsAddons, some candidates for KPimWidgets?
TODO libkdepimdbusinterfaces KOrganizer DBus interfaces (.xml) + some . Why is it even a stanadlone library?
TODO libkleo -> KF5Kleo (-> KF5Crypto? :))
TODO libksieve Sieve interaction library + Sieve widgets, split to Sieve Framework (like KIMAP), move most of the widgets to Sieve IDE, keep only those used directly from KMail?
TODO libsendlater Why is this even a library?
TODO mailcommon
TODO mailcommon/filter Local mail filters
TODO mailcommon/collectionpage Collection properties dialog pages -> move to Akonadi?
TODO mailcommon/folder Mail folders abstraction and glue-code between the abstraction and Akonadi collections
TODO mailcommon/job Random folder-related jobs
TODO mailcommon/search Widgets and some logic for the big Search dialog
TODO mailcommon/snippets ??
TODO mailcommon/tags Akonadi Tag abstraction. There are some tag widgets in libkdepim too. Merge?
TODO mailcommon/widget Random widgets
TODO mailcommon/mdn SendMDNHandler <- merge to KMail?
TODO mailcommon/util mailutil.h - random helper functions
TODO mailcommon/kernel The Kernel singleton that unifies access to various interfaces
TODO mailimporter
TODO mboximporter Merge with mailimporter?
TODO messagecomposer email composer and tons of helper code and utilities
TODO messagecore
TODO messagecore/attachment Attachment handling code; merge with messagecomposer/attachment?
TODO messagecore/misc/mailinglist.cpp Extracts ML information from emails
TODO messagecore/misc/mdnstateattribute.cpp Why is this not in mailcommon/mdn?
TODO messagecore/settings KCFG file; seems to contain Reader and Composer settings. Kill?
TODO messagecore/util String-handling utilities, some deprecated
TODO messagelist The entire messagelist pane from KMail, Akonadi-specific implementation of the abstract MessageList::Core::StorageModel (flatten the abstraction??)
TODO messagelist/core The Model, View, themes and delegates
TODO messagelist/utils Configuration dialogs for aggregation, threading and themes
TODO messageviewer
TODO messageviewer/a11y A11y for viewer, does not really look like it works (the implementation is mostly empty
TODO messageviewer/adblock Pretty complete adblock for emails. Make it a plugin?
TODO messageviewer/antispam Read antispam mail headers and shows the results in UI + some configuration. Could be OTP part/plugin?
TODO messageviewer/findbar Search bar for the webview
TODO messageviewer/grantleefilters Mail-specific Grantlee template filters
TODO messageviewer/gravatar Fetch sender's face from interwebs
TODO messageviewer/header Mail header styles
TODO messageviewer/htmlwriter Dump rendered email HTML to file?
TODO messageviewer/interfaces OTP interfaces?
TODO messageviewer/job Attachment, Kleo, Mail-to-event/note jobs
TODO messageviewer/notify Get KNotifications when new adblock list is available :-O
TODO messageviewer/scamdetection Detect possible scam mails using different heuristics. Could be OTP part/plugin, like antispam and adblock?
TODO messageviewer/themes Grantlee themes examples
TODO messageviewer/viewer The Viewer + OTP
TODO messageviewer/viewerplugins Good start on viewer plugins, few default plugins
TODO messageviewer/widgets
TODO noteshared Share Notes via local network (?)
TODO pimcommon/acl Collection ACL settings/widgets. Move to mailcommon/collectionpage?
TODO pimcommon/autocorrection Use Sonnet instead? Used in composer only
TODO pimcommon/baloodebug Move to PIM Search, rename
TODO pimcommon/customtools Interface for custom (composer?) plugins, shorturl and translator plugins, move to composer?
TODO pimcommon/gravatar Merge with messageviewer/gravatar
TODO pimcommon/manageserversidesubscription Dialog to mange server-side subscription - IMAP/Kolab specific, should be moved to the resources?
TODO pimcommon/migration Migrate app config and data files for KDE4->KF5?
TODO pimcommon/settings KCFG for individual submodules, IMO each submodule should have its own settings
TODO pimcommon/shareserviceurlmanager KPurpose/KSocial/KIPI/standalone framework?
TODO pimcommon/shorturl Configure and talk to URL shortener services. KPurpose/KIPI candidate, or a standalone framework?
TODO pimcommon/sievehighlighter Why is this not part of libksieve?
TODO pimcommon/storageservice Our own Dolphin :) Talk to KPurpose/KIPI and merge it there, or create a standalone framework for remote storage access
TODO pimcommon/templatewidgets Probably mail templates? Move to mailcommon then
TODO pimcommon/temporaryfile Create temporary dir for opening attachments. mailcommon/mailviewer?
TODO pimcommon/texteditor Our very own Kate :-). Kill and use KTextEdit?
TODO pimcommon/texttospeech TTS abstraction (currently hardcodes unreleased QTextToSpeech). Do we even need an abstraction (once QTTS is released)
TODO pimcommon/translator Talks to Google Translate to translate your emails. GT does not have an API, so not a good candidate for KGAPI, but could be merged to the translate plugin that lives somewhere in messageviewer or mailcommon?
TODO pimcommon/util ....
TODO pimcommon/util/createresource.cpp Synchronously create an Akonadi resource + error handling. Move to AgentManager?
TODO pimcommon/util/editorutil.cpp
TODO pimcommon/util/imapresourcecapabilitiesmanager.cpp Queries IMAP server capabilities via DBus (by talking to the resource
TODO pimcommon/util/networkutil.cpp Singleton that holds if low-bandwidth mode is enabled
TODO pimcommon/util/pimutil.cpp Random stuff
TODO pimcommon/util/vcardutil.cpp Replaces X-messaging/FOO-All by X-FOO in raw vcard ???
TODO pimcommon/webshortcut Gain access to webshortcuts configured in webshortcuts KCM
TODO pimcommon/widgets ....
TODO pimcommon/widgets/annotationdialog.cpp Create item notes (annotations)
TODO pimcommon/widgets/configureimmutablewidgetutils.cpp Something that should go to KConfig(Widgets)
TODO pimcommon/widgets/customtextedit.cpp In case the 2 editors in pimcommon/texteditor are not enough
TODO pimcommon/widgets/customtreeview.cpp QTreeView that can show a centered text when it's empty
TODO pimcommon/widgets/emailaddressrequester.cpp KLineEdit with button to choose contact from address book
TODO pimcommon/widgets/kactionmenuchangecase.cpp creates KActions to change convert word or sentece to lower/upper case. How is this even useful? :D
TODO pimcommon/widget/lineeditwidgetcompleter.cpp KLineEdit with special context-menu action to clear its KCompletion history
TODO pimcommon/widget/manageaccountwidget.cpp Add/remove/configure Akonadi resources widget. Move to libakonadi
TODO pimcommon/widget/minimumcombobox.cpp Literally a tiny KComboBox
TODO pimcommon/widget/renamefiledialog.cpp
TODO pimcommon/widget/simplestringlisteditor.cpp QDialog to add/modify/remove/reorder list of strings. -> KWidgetAddons?
TODO pimcommon/widget/slidecontainer.cpp A hidden-by-default widget that slides in when shown. Do we even need this fancy stuff?
TODO pimcommon/widget/spellchecklineedit.cpp PimCommon::RichTextEdit with magical powers
TODO sieveeditor Sieve IDE
TODO storageservicemanager Our own Dolphin, part 2
TODO templateparser Message templates (reply/forward/... templates) parser, editor and manager

Content is available under Creative Commons License SA 4.0 unless otherwise noted.