Difference between revisions of "Projects/PIM/MS Windows"

Revision as of 10:01, 16 April 2008

This page covers topics related to the MS Windows port of the KDE PIM suite.

Note
This page is work in progress started by jstaniek.

Building

build base KDE libraries for Windows with required dependencies, preferable using emerge tool (because it tracks dependencies for you):
1. install emerge and its dependencies as described here
2. from the cmd.exe command line, enter
```
emerge kdepimlibs
```
  - that will also build qt, kdesupport (part of it), soprano, strigi, kdelibs, kdebase
3. enter
```
emerge libassuan
```
  - this is an optional dependency of kdepim
4. finally, enter
```
emerge kdepim
```

Problem points

Maildir implementation in KMail

It is to be expected, that the maildir implementation in kmail does not work on Windows' file system, since it uses the ":" (forbidden on windows) character in file names. It also relies (as does maildir in general) on the atomicity of making a hardlink and then unlinking the original, to implement an atomic move. The implementation used by akonadi (kdepim/maildir) relies on QFile in that regard, but it's unclear if rename is atomic on all platforms.

jstaniek 12:50, 7 January 2008 (CET): Hard/soft links could be handled on Windows by altering the source code so that the "link" file is a text file itself and contains the target path. If we need atomic renames, Windows apparently lacks them, I have found a pre-Vista blog which contains description on how to perform them in a messy but honest way (look at the very last "Write process (on Foo.txt)" version). There's also a way to recover from application/system crash during the pseudo-atomic operations (see the very last "Recovery from a crash during write" checklist).
jstaniek 12:42, 24 January 2008 (CET): We will most probably benefit from maildir suport on Windows as Thunderbird (ver. <3) apparently lacks support for this storage, despite many wishes and plans.
jstaniek 12:42, 24 January 2008 (CET): regarding replacing ":" character on windows:
- We cannot use ":" in any way (Wikipedia note), so we have to rename it to something other:
  - The proposed replace character is "!". Not "-" (see this for explanation).
  - We may want to add support for user-defined character, to allow reuse maildirs of apps like mutt (which uses "-"), but it should be clearly noted in the handbook that the setting is only for integration with existing maildirs.
  - The rename makes the implementation incompatible with the specification (which is informal anyway and says nothing about the replacement character).
- The ability of sharing a single maildir structure on dual boot machines (e.g., using the IFS Ext2 driver or Ext2fsd: way less crashy than IFS Ext2 (no blue screen of the death) and actively maintained) is affected by the problem with ":" character.
  - Windows FS layer apparently returns "file not found" error for files having the ":" character on a linux filesystem. So if there is a need for storing the maildir at linux side, ":" should be renamed even if Linux itself does work with ":".
  - Conversely, if the maildir has to be stored at windows side, ":" characters have to be renamed, do Linux build of KMail (and KDE-PIM in general) should support this rename too in order to access the storage.

Integration into the Windows Explorer & Desktop

Note
jstaniek 22:01, 14 January 2008 (CET): TortoiseSVN is GPLed SVN client which is nicely integrated with Windows Explorer. Perhaps we can use its source code as a reference...

Registry settings for default apps and services

Introduction: We can detect whether KMail is the default e-mail client. If set as default, KMail should act as a default mailer, and thus be invoked automatically for actions like RMB "Send To -> E-mail Recipient". This shall be also reused by others for KOrganizer and Konqueror. The solution is relatively simple modifications to the Windows Registry. See Mozilla's solution.

First, we can use HKLM node for system-global settings or HKCU node for current-user-only settings. If the attempt to set the value in HKLM fails, usually because of unsufficient permissions, HKCU should be used. As expected, HKCU has overrides HKLM settings. See KB297878. Below we'll use HKCU.

HKCU\Software\Clients\StartMenuInternet key is used to specify default web browser; could be set to Konqueror
HKCU\Software\Clients\StartMenuInternet\app.exe\shell\open\command key is used for "Internet" start menu shortcut, can be set to Konqueror. Note from the KB - "The command might open the browser on the users home page, for example. However, it might launch some other introductory user interface that the ISV feels is appropriate." So this is not the same as 'default browser' setting.

HKCU\Software\Clients\Mail\Appname - registered email client, there can be more entries within the 'Mail' node. Adding KMail here makes it available for users to select as a default browser using 'Set Default Programs' system window.
HKCU\Software\Clients\Mail - default email client, 'Windows Mail' by default; could be set to KMail.

HKCU\Software\Clients\Calendar\Appname - registered calendar application, there can be more entries within the 'Calendar' node. See the note for HKCU\Software\Clients\Mail\Appname.
HKCU\Software\Clients\Calendar - default calendar application, 'Windows Calendar' on Vista; could be set to KOrganizer.

HKCU\Software\Clients\Contacts\Appname - registered contacts client, there can be more entries within the 'Contacts' node. See the note for HKCU\Software\Clients\Mail\Appname.
HKCU\Software\Clients\Contacts - default contacts application, 'Address Book' by default; could be set to KAddressBook.

HKCU\Software\Clients\News\Appname - registered newsgroup client, there can be more entries within the 'News' node. See the note for HKCU\Software\Clients\Mail\Appname.
HKCU\Software\Clients\News - default newsgroup application, 'Windows Mail' by default; could be set to KNode.

From the KB: After updating the registry keys, the application broadcasts the WM_SETTINGCHANGE message with wParam = 0 and lParam pointing to the null-terminated string "Software\Clients\StartMenuInternet" to notify the operating system that the default client has changed.

KDE-related notes

KDElibs execute default web browser or email client for protocols like http(s): and mailto: via QDesktopServices::openUrl(), which in turn uses ShellExecute(). openUrl() is widely used in Qt e.g. for hyperlinks in text boxes and label widgets.
A general rule of KDE/win: not to duplicate registry settings in any rc file and use default applications if possible, to avoid changing behaviour expected by users.

Drag&drop support

Support drag&drop from/to composer and from received mails into the file system (Windows Explorer and the Desktop)

Copy&paste support

Support pasting files copied (in Windows Explorer or the Desktop) as attachments.

Profile migration

Mozilla profile directories

SASL support

Note
SASL should be available before building kdepimlibs. When you build kdepimlibs, it should display message like "SASL Found" during configure stage.

Build SASL by hand

Cyrus SASL is used on Windows for SSL/TLS, so we use the same source code plus wrapper functions that are a part of the Cyrus distribution (the result is a native Windows library, do not confuse with Cygwin!).

Two Mozilla's patches have to be applied for msvc.

Cyrus SASL functionality is based on plugins. For KDEpimlibs we have set the paths for plugins and configuration to KDEROOT/lib/sasl2/ and KDEROOT/share/config/sasl2/, respectively. The configuration capatibilities are apparently not used for now. (jstaniek February 3 2008)

The following parts of KDEpimlibs depend on sasl2: kldap, kioslave/{sieve|imap4|smtp|pop3}.

Limitations: Currently all plugins but KerberosV4 (kerberos4.c) and PASSDSS (passdss.c) can be built on Windows. (more info)

See also:

Negotiateauth Mozilla plugin and Mod_auth_kerb Apache module for Kerberos support.
this thread

Insert non-formatted text here

Download SASL for mingw and msvc

Download SASL library and plugins for mingw and msvc. Here's link, this time uploaded to the wiki (TODO move it to the public): https://kowi-intern.intevation.de/KoWi-P-Status/ChangesSinceLastDrop?action=AttachFile&do=get&target=cyrus-sasl2.zip. The archive provides directory structure, so you'll know where to unpack these files.

Notes

The branches/work/kdab-post-4.0 branch (kdepimlibs, kdepim modules) have been closed and merged into trunk. KDE PIM for Windows development happens in trunk again now.

Links

The KDE on Windows Project
Missing features of kdelibs on Windows - KDE PIM may depend on them

External Links

Find out how others have managed to port their software to Windows:
- Building Firefox on Windows using msvc
- Building Cyrus SASL on Windows

@@ Line 59: / Line 59: @@
 *[http://kb.mozillazine.org/Profile_folder Mozilla profile directories]
 ===SASL support===
+{{Note|SASL should be available '''before''' building kdepimlibs. When you build kdepimlibs, it should display message like "SASL Found" during configure stage.}}
+====Build SASL by hand====
 [http://asg.web.cmu.edu/sasl/ Cyrus SASL] is used on Windows for SSL/TLS, so we use the same source code plus wrapper functions that are a part of the Cyrus distribution (the result is a native Windows library, do not confuse with Cygwin!).
@@ Line 72: / Line 74: @@
 *[http://negotiateauth.mozdev.org/ Negotiateauth] Mozilla plugin and [http://sourceforge.net/projects/modauthkerb/ Mod_auth_kerb] Apache module for Kerberos support.
 *[http://mailman.mit.edu/pipermail/kerberos/2004-April/005152.html this] [http://mailman.mit.edu/pipermail/kerberos/2004-April/005155.html thread]
+<nowiki>Insert non-formatted text here</nowiki>
+====Download SASL for mingw and msvc====
+Download SASL library and plugins for mingw and msvc. Here's link, this time uploaded to the wiki (TODO move it to the public): https://kowi-intern.intevation.de/KoWi-P-Status/ChangesSinceLastDrop?action=AttachFile&do=get&target=cyrus-sasl2.zip. The archive provides directory structure, so you'll know where to unpack these files.
 == Notes ==