alvinhochun/kritashellextension

Shell Extension for Krita files in Windows Explorer to provide thumbnail support and metadata info.

Krita Shell Extension

Shell Extension to provide various information about Krita files in Windows Explorer.

You can download Krita at https://krita.org/

License

The MIT License

Copyright (c) 2016-2022 Alvin Wong

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Acknowledgement

This software uses the following libraries:

• libzip - BSD-like license - http://www.nih.at/libzip/
• zlib - zlib license - http://www.zlib.net/
• TinyXML-2 - zlib license https://github.com/leethomason/tinyxml2

For the license information on these libraries, you can either refer to the above URLs, or refer to the corresponding COPYING files included in the source tree and/or binary release package.

System Requirements

This shell extension requires Windows Vista or above. It does not work on Windows XP and previous versions of Windows.

The released installer checks for Windows 7 or above, so it can not be used directly on Windows Vista.

The binaries were compiled using Visual Studio 2015. They are linked statically against the C++ runtime, so no extra runtime libraries are needed for this to work.

Installing

Executing the installer should work without any trouble.

Installing the shell extensions by regsvr32 is not supported.

Using

Once this library is registered on the system, it will automatically work inside Windows Explorer and other shell components (e.g. File Dialogs) without needing further actions.

Building From Source

The project has been compiled and tested with CMake 3.4.3 using both NMake Makefile and Visual Studio 2015.

External libraries should be automatically downloaded and compiled by the build system. You can also choose to download their sources manually by replacing deps/CMakeLists.txt with deps/CMakeLists_uselocal.txt. Note that you may need to change the CMakeLists.txt of libzip manually to add the static library target.

You have to build the 32-bit and 64-bit versions separately. Using an out-of-source build location is recommended.

Example build commands:

• Visual Studio 2015 64-bit build:

    cmake -G "Visual Studio 14 2015 Win64" <path_to_source>
    cmake --build . --config Release
  

• NMake (within Visual Studio command prompt):

    cmake -G "NMake Makefiles" -DCMAKE_BUILD_TYPE=Release <path_to_source>
    cmake --build .
  

Currently, the project does not include an install target. You will have to copy the output manually or using an external script. The output DLL is located at

<build_dir>\KritaShellExtension\<config>\kritashellex##.dll

or

<build_dir>\KritaShellExtension\kritashellex##.dll

depending on the generator you use, where ## is the target architecture.

To build the NSIS installer, refer to the readme file under installer/nsis.

Additional Information

KritaThumbnailProvider

Provides preview thumbnail for .kra and .ora files.

KritaPropertyHandler

Provides image file properties for .kra and .ora files. Additional registry changes are needed for it to work the best.

zip_source_IStream

Utility allowing libzip to read zip archives directly from the COM interface IStream without needing to load the content of the entire stream into memory beforehand, saving some time and reducing memory usage.

kritashellextension's Issues

Decouple the Krita installer scripts

In short: move the Krita installer scripts to the Krita repository.

There is absolutely no reason to keep it here. This shell extension is rarely updated (as for now), but the Krita installer would need to be updated to match the feature set of Krita.

I'll need to find a way to to make this work.

Add Krita to the Open With list for other common image formats

https://bugs.kde.org/show_bug.cgi?id=389650

Check colourspace of mergeimage in .ora files

It seems that the colourspace and blending of the mergedimage.png in .ora files is different from that .kra files? The rendering (alpha blending) behaviour of them in the preview pane seems a bit different.

Detect running Krita before uninstall / upgrade

Detect if Krita is running before uninstall / upgrade, since things can't be deleted when it's running.

Or should we just detect failure on deletion?

Prompts not bypassed in silent mode

https://bugs.kde.org/show_bug.cgi?id=393098

Windows Explorer locks file if extention failed to parse it

As per https://bugs.kde.org/show_bug.cgi?id=377367

It's probably something wrong with IInitializeWithStream::Initialize.

From MSDN,

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code

Currently the fail cases return E_NOTIMPL. Maybe Explorer doesn't like it? Probably should return E_FAIL instead.

Access Violation or crash for certain files

As per https://www.reddit.com/r/krita/comments/56ndpg/shell_extension_returning_error_krita_3011/ and a previous report on irc

May be autosave files

The small preview is cropped to the non-transparent area of the canvas

It is very noticeable if you resize the preview pane when it transits between the small one and large one.

"Create desktop icon" checkbox doesn't do anything

Well, I think I know how to fix that.

Uninstaller: Delete only installed files

Doing a recursive delete is probably not the best idea, in case if someone installed it to somewhere that already contains certain files?

https://github.com/alvinhochun/KritaShellExtension/blob/v1.1b/installer/nsis/installer_krita.nsi#L302

kritashellex_1.1.0.1_setup.exe infected with Win32/Fathale.B!plock

Windows Defender reports the kritashellex_1.1.0.1_setup.exe as infected with Win32/Fathale.B!plock:

https://www.microsoft.com/security/portal/threat/encyclopedia/entry.aspx?name=Trojan%3aWin32%2fFathale.B!plock&threatid=2147709273&enterprise=0

Any idea what's going on?

Build shell extension with debug info

Allow new versions of the shell extension to be installed over the one bundled with the Krita installer

Currently, the Krita installer force-remove the shell extension, and the shell extension won't install if Krita is installed.

The ultimate idea is to allow the user to install a newer version of the shell extension over an existing Krita installation, so to allow the user to update the shell extension without updating Krita (which is, btw, not exactly the intended use.)

If a new version of the shell extension is installed, then the Krita uninstaller would need to properly uninstall the new version. Three ways to deal with this:

• Embed the shell extension installer within the Krita installer. The shell extension installer has to accept path to krita.exe from the command line. When uninstalling Krita, just execute the shell extension uninstaller too.
  • It just seems weird?...
• Save install log and use it in the uninstaller, the shell extension installers can change the install log or place a new install log, so that the uninstaller can use them to remove the new version of the shell extension properly
  • Probably the cleanest way, but how should I generate the install log?
• In the Krita uninstaller, look for the uninstaller for the shell extension, and use it to uninstall the shell extension instead of using the included functions.
  • Probably the easiest way.

Small preview is stretched to 256px on the longest edge

The image is still stretched even when the longest edge of the image is below 256px. This causes a jump in resolution when resizing the preview pane past the 256px size switch.

Maybe we should use the mergedimage.png in that case.

Refactor the code that involves reading stuff from the files

The thumbnail provider is going to need to read the file dimensions... make it so thatj the related code is extracted from the property handler into its own class.

Probably have a class to handle stuff, including lazy-init getters and stuff.

Implement windows version detection

Krita 3.0 is only tested on Windows 7+

The shell extension only works on Vista+ and only tested on Windows 7+

Thumbnail and properties for .ora files

Technically should be pretty similar to .kra files except for some name changes.