├── .gitignore ├── Messages.sh ├── uninstall.sh ├── install.sh ├── src ├── plasma-runner-nheko-krunner.desktop ├── NhekoKRunnerConfig.h ├── kcm_nheko-krunner.desktop ├── CMakeLists.txt ├── nheko-krunner.h ├── NhekoKRunnerConfig.cpp ├── NhekoDBusApi.h ├── nheko-krunner.cpp └── NhekoDBusApi.cpp ├── README.md ├── CMakeLists.txt ├── .clang-format ├── LICENSES └── LGPL-2.1-or-later.txt └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *build*/ 2 | CMakeLists.txt.user 3 | .kdev*/ 4 | *.kdev* 5 | -------------------------------------------------------------------------------- /Messages.sh: -------------------------------------------------------------------------------- 1 | #! /usr/bin/env bash 2 | $XGETTEXT src/*.cpp -o $podir/plasma_runner_org.kde.%{APPNAMELC}.pot 3 | -------------------------------------------------------------------------------- /uninstall.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Exit if something fails 4 | set -e 5 | 6 | cd build 7 | sudo make uninstall 8 | 9 | # KRunner needs to be restarted for the changes to be applied 10 | # we can just kill it and it will be started when the shortcut is invoked 11 | kquitapp5 krunner 12 | -------------------------------------------------------------------------------- /install.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Exit if something fails 4 | set -e 5 | 6 | mkdir -p build 7 | cd build 8 | 9 | cmake -DKDE_INSTALL_PLUGINDIR=`kf5-config --qt-plugins` -DCMAKE_BUILD_TYPE=Release .. 10 | make -j$(nproc) 11 | sudo make install 12 | 13 | # KRunner needs to be restarted for the changes to be applied 14 | # we can just kill it and it will be started when the shortcut is invoked 15 | kquitapp5 krunner 16 | -------------------------------------------------------------------------------- /src/plasma-runner-nheko-krunner.desktop: -------------------------------------------------------------------------------- 1 | [Desktop Entry] 2 | Name=nheko 3 | Comment=List rooms and perform other actions with nheko. 4 | Icon=nheko 5 | 6 | X-KDE-ServiceTypes=Plasma/Runner 7 | Type=Service 8 | 9 | X-KDE-PluginInfo-Author=Loren Burkholder 10 | X-KDE-PluginInfo-Email=computersemiexpert@outlook.com 11 | X-KDE-PluginInfo-Name=nheko-krunner 12 | X-KDE-PluginInfo-Version=0.1.0 13 | X-KDE-PluginInfo-License=LGPL 2.1+ 14 | X-KDE-PluginInfo-EnabledByDefault=true 15 | X-KDE-ConfigModule=kf5/krunner/kcms/kcm_nheko-krunner 16 | -------------------------------------------------------------------------------- /src/NhekoKRunnerConfig.h: -------------------------------------------------------------------------------- 1 | #ifndef NHEKOKRUNNERCONFIG_H 2 | #define NHEKOKRUNNERCONFIG_H 3 | 4 | #include 5 | 6 | #include 7 | #include 8 | 9 | class NhekoKRunnerConfig : public KCModule 10 | { 11 | Q_OBJECT 12 | 13 | public: 14 | NhekoKRunnerConfig(QWidget *parent = nullptr, const QVariantList &args = {}); 15 | 16 | virtual void load() override; 17 | virtual void save() override; 18 | virtual void defaults() override; 19 | 20 | private: 21 | QCheckBox *m_showNotificationCounts; 22 | }; 23 | 24 | #endif // NHEKOKRUNNERCONFIG_H 25 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # nheko-krunner 2 | 3 | A KRunner plugin to list joined rooms and possibly other things from [nheko](https://nheko-reborn.github.io). 4 | 5 | This project was initially based off of the template project found [here](https://invent.kde.org/frameworks/krunner/-/tree/master/templates/runner). 6 | 7 | ### Build instructions 8 | 9 | ```bash 10 | mkdir build 11 | cd build 12 | cmake -DKDE_INSTALL_PLUGINDIR=`kf5-config --qt-plugins` .. 13 | make 14 | make install 15 | kquitapp5 krunner 16 | ``` 17 | 18 | However, running `./install.sh` will do more or less the exact same thing with only one command. 19 | 20 | Theoretically, KRunner will automatically relaunch itself and pick up on the new plugin. 21 | -------------------------------------------------------------------------------- /src/kcm_nheko-krunner.desktop: -------------------------------------------------------------------------------- 1 | [Desktop Entry] 2 | Name=nheko 3 | Comment=Configure the KRunner plugin for nheko. 4 | Icon=nheko 5 | Exec=systemsettings kcm_nheko-krunner 6 | Type=Service 7 | Categories=Qt;KDE;X-KDE-settings-system; 8 | 9 | X-KDE-ServiceTypes=KCModule 10 | X-KDE-ParentApp=systemsettings 11 | X-KDE-PluginInfo-Author=Loren Burkholder 12 | X-KDE-PluginInfo-Email=computersemiexpert@outlook.com 13 | X-KDE-PluginInfo-Name=kcm_nheko-krunner 14 | X-KDE-ParentComponents=nheko-krunner 15 | X-KDE-PluginInfo-Version=0.1.0 16 | X-KDE-PluginInfo-License=LGPL 2.1+ 17 | X-KDE-PluginInfo-EnabledByDefault=true 18 | # X-KDE-System-Settings-Parent-Category= 19 | X-KDE-Keywords=nheko,matrix 20 | X-KDE-Library=nheko-krunner 21 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.16) 2 | 3 | set(CMAKE_CXX_STANDARD 20) 4 | set(CMAKE_CXX_STANDARD_REQUIRED ON) 5 | 6 | project(nheko-krunner VERSION 0.2.0 LANGUAGES CXX) 7 | 8 | set(KF5_MIN_VERSION "5.90.0") 9 | 10 | set(CMAKE_AUTOMOC ON) 11 | 12 | find_package(ECM ${KF5_MIN_VERSION} REQUIRED NO_MODULE) 13 | set(CMAKE_MODULE_PATH ${ECM_MODULE_PATH}) 14 | find_package(Qt5 5.15.2 CONFIG REQUIRED COMPONENTS Widgets DBus) 15 | find_package(KF5 ${KF5_MIN_VERSION} REQUIRED COMPONENTS Runner KCMUtils I18n) 16 | 17 | include(KDEInstallDirs) 18 | include(KDECMakeSettings) 19 | include(KDEFrameworkCompilerSettings NO_POLICY_SCOPE) 20 | include(FeatureSummary) 21 | 22 | add_subdirectory(src) 23 | 24 | feature_summary(WHAT ALL INCLUDE_QUIET_PACKAGES FATAL_ON_MISSING_REQUIRED_PACKAGES) 25 | -------------------------------------------------------------------------------- /src/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | add_definitions(-DTRANSLATION_DOMAIN=\"plasma_runner_org.kde.nheko-krunner\") 2 | 3 | add_library(nheko-krunner MODULE) 4 | 5 | target_sources(nheko-krunner PRIVATE 6 | nheko-krunner.cpp 7 | nheko-krunner.h 8 | NhekoDBusApi.cpp 9 | NhekoDBusApi.h 10 | ) 11 | 12 | kcoreaddons_desktop_to_json(nheko-krunner plasma-runner-nheko-krunner.desktop) 13 | target_link_libraries(nheko-krunner 14 | KF5::Runner 15 | Qt5::DBus 16 | ) 17 | 18 | install(TARGETS nheko-krunner DESTINATION ${KDE_INSTALL_PLUGINDIR}/kf5/krunner) 19 | install(FILES plasma-runner-nheko-krunner.desktop DESTINATION ${KDE_INSTALL_KSERVICESDIR}) 20 | 21 | # This prevents deprecated API from being used 22 | include(ECMDeprecationSettings) 23 | ecm_set_disabled_deprecation_versions( 24 | QT 5.15.2 25 | KF ${KF5_MIN_VERSION} 26 | ) 27 | 28 | kcoreaddons_add_plugin(kcm_nheko-krunner SOURCES NhekoKRunnerConfig.cpp INSTALL_NAMESPACE kf5/krunner/kcms) 29 | target_link_libraries(kcm_nheko-krunner 30 | KF5::KCMUtils 31 | KF5::ConfigCore 32 | KF5::ConfigWidgets 33 | ) 34 | -------------------------------------------------------------------------------- /src/nheko-krunner.h: -------------------------------------------------------------------------------- 1 | /* 2 | SPDX-FileCopyrightText: 2022 Loren Burkholder 3 | 4 | SPDX-License-Identifier: LGPL-2.1-or-later 5 | */ 6 | 7 | #ifndef NHEKOKRUNNER_H 8 | #define NHEKOKRUNNER_H 9 | 10 | #include 11 | 12 | #include "NhekoDBusApi.h" 13 | 14 | enum ActionType 15 | { 16 | OpenRoom, 17 | JoinRoom, 18 | DirectMessage, 19 | }; 20 | 21 | struct NhekoAction 22 | { 23 | QString id; 24 | ActionType actionType; 25 | }; 26 | Q_DECLARE_METATYPE(NhekoAction) 27 | 28 | class NhekoKRunner : public Plasma::AbstractRunner 29 | { 30 | Q_OBJECT 31 | 32 | public: 33 | NhekoKRunner(QObject *parent, const KPluginMetaData &metadata, const QVariantList &args); 34 | ~NhekoKRunner() override; 35 | 36 | public: // Plasma::AbstractRunner API 37 | void match(Plasma::RunnerContext &context) override; 38 | void run(const Plasma::RunnerContext &context, const Plasma::QueryMatch &match) override; 39 | virtual void reloadConfiguration() override; 40 | 41 | private: 42 | QVector m_rooms; 43 | bool m_dbusConnected{true}; 44 | 45 | // config 46 | bool m_showNotificationCounts{true}; 47 | }; 48 | 49 | #endif 50 | -------------------------------------------------------------------------------- /src/NhekoKRunnerConfig.cpp: -------------------------------------------------------------------------------- 1 | #include "NhekoKRunnerConfig.h" 2 | 3 | #include 4 | #include 5 | #include 6 | #include 7 | 8 | #include 9 | 10 | NhekoKRunnerConfig::NhekoKRunnerConfig(QWidget *parent, const QVariantList &args) 11 | : KCModule{parent, args} 12 | { 13 | auto about = new KAboutData{QStringLiteral("nheko-krunner"), 14 | QStringLiteral("nheko"), 15 | QStringLiteral("0.2.0"), 16 | tr("List rooms and perform other actions with nheko."), 17 | KAboutLicense::LGPL_V2_1}; 18 | about->addAuthor(QStringLiteral("Loren Burkholder"), tr("Author"), QStringLiteral("computersemiexpert@outlook.com")); 19 | setAboutData(about); 20 | setButtons(Apply); 21 | 22 | auto layout = new QGridLayout{this}; 23 | m_showNotificationCounts = new QCheckBox{tr("Display unread notification counts next to rooms")}; 24 | layout->addWidget(m_showNotificationCounts); 25 | 26 | connect(m_showNotificationCounts, &QCheckBox::stateChanged, this, &NhekoKRunnerConfig::markAsChanged); 27 | } 28 | 29 | void NhekoKRunnerConfig::load() 30 | { 31 | auto config = KSharedConfig::openConfig(QStringLiteral("krunnerrc")) 32 | ->group(QStringLiteral("Runners")) 33 | .group(QStringLiteral("nheko-krunner")); 34 | 35 | m_showNotificationCounts->setChecked(config.readEntry(QStringLiteral("showNotificationCounts"), true)); 36 | 37 | KCModule::load(); 38 | 39 | Q_EMIT changed(false); 40 | } 41 | 42 | void NhekoKRunnerConfig::save() 43 | { 44 | auto config = KSharedConfig::openConfig(QStringLiteral("krunnerrc")) 45 | ->group(QStringLiteral("Runners")) 46 | .group(QStringLiteral("nheko-krunner")); 47 | 48 | config.writeEntry(QStringLiteral("showNotificationCounts"), m_showNotificationCounts->isChecked()); 49 | config.sync(); 50 | 51 | KCModule::save(); 52 | 53 | Q_EMIT changed(false); 54 | } 55 | 56 | void NhekoKRunnerConfig::defaults() 57 | { 58 | m_showNotificationCounts->setChecked(true); 59 | 60 | KCModule::defaults(); 61 | 62 | markAsChanged(); 63 | } 64 | 65 | K_PLUGIN_CLASS(NhekoKRunnerConfig) 66 | 67 | #include "NhekoKRunnerConfig.moc" 68 | -------------------------------------------------------------------------------- /.clang-format: -------------------------------------------------------------------------------- 1 | --- 2 | # SPDX-FileCopyrightText: 2019 Christoph Cullmann 3 | # SPDX-FileCopyrightText: 2019 Gernot Gebhard 4 | # 5 | # SPDX-License-Identifier: MIT 6 | 7 | # This file got automatically created by ECM, do not edit 8 | # See https://clang.llvm.org/docs/ClangFormatStyleOptions.html for the config options 9 | # and https://community.kde.org/Policies/Frameworks_Coding_Style#Clang-format_automatic_code_formatting 10 | # for clang-format tips & tricks 11 | --- 12 | Language: JavaScript 13 | DisableFormat: true 14 | --- 15 | 16 | # Style for C++ 17 | Language: Cpp 18 | 19 | # base is WebKit coding style: https://webkit.org/code-style-guidelines/ 20 | # below are only things set that diverge from this style! 21 | BasedOnStyle: WebKit 22 | 23 | # enforce C++11 (e.g. for std::vector> 24 | Standard: Cpp11 25 | 26 | # 4 spaces indent 27 | TabWidth: 4 28 | 29 | # 2 * 80 wide lines 30 | ColumnLimit: 160 31 | 32 | # sort includes inside line separated groups 33 | SortIncludes: true 34 | 35 | # break before braces on function, namespace and class definitions. 36 | BreakBeforeBraces: Linux 37 | 38 | # CrlInstruction *a; 39 | PointerAlignment: Right 40 | 41 | # horizontally aligns arguments after an open bracket. 42 | AlignAfterOpenBracket: Align 43 | 44 | # don't move all parameters to new line 45 | AllowAllParametersOfDeclarationOnNextLine: false 46 | 47 | # no single line functions 48 | AllowShortFunctionsOnASingleLine: None 49 | 50 | # always break before you encounter multi line strings 51 | AlwaysBreakBeforeMultilineStrings: true 52 | 53 | # don't move arguments to own lines if they are not all on the same 54 | BinPackArguments: false 55 | 56 | # don't move parameters to own lines if they are not all on the same 57 | BinPackParameters: false 58 | 59 | # In case we have an if statement with multiple lines the operator should be at the beginning of the line 60 | # but we do not want to break assignments 61 | BreakBeforeBinaryOperators: NonAssignment 62 | 63 | # format C++11 braced lists like function calls 64 | Cpp11BracedListStyle: true 65 | 66 | # do not put a space before C++11 braced lists 67 | SpaceBeforeCpp11BracedList: false 68 | 69 | # remove empty lines 70 | KeepEmptyLinesAtTheStartOfBlocks: false 71 | 72 | # no namespace indentation to keep indent level low 73 | NamespaceIndentation: None 74 | 75 | # we use template< without space. 76 | SpaceAfterTemplateKeyword: false 77 | 78 | # Always break after template declaration 79 | AlwaysBreakTemplateDeclarations: true 80 | 81 | # macros for which the opening brace stays attached. 82 | ForEachMacros: [ foreach, Q_FOREACH, BOOST_FOREACH, forever, Q_FOREVER, QBENCHMARK, QBENCHMARK_ONCE , wl_resource_for_each, wl_resource_for_each_safe ] 83 | 84 | # keep lambda formatting multi-line if not empty 85 | AllowShortLambdasOnASingleLine: Empty 86 | 87 | # We do not want clang-format to put all arguments on a new line 88 | AllowAllArgumentsOnNextLine: false 89 | -------------------------------------------------------------------------------- /src/NhekoDBusApi.h: -------------------------------------------------------------------------------- 1 | // SPDX-FileCopyrightText: 2022 Nheko Contributors 2 | // SPDX-FileCopyrightText: 2023 Nheko Contributors 3 | // 4 | // SPDX-License-Identifier: GPL-3.0-or-later 5 | 6 | #ifndef NHEKODBUSAPI_H 7 | #define NHEKODBUSAPI_H 8 | 9 | #include 10 | #include 11 | #include 12 | #include 13 | 14 | namespace nheko::dbus { 15 | 16 | //! Registers all necessary classes with D-Bus. Call this before using any nheko D-Bus classes. 17 | void 18 | init(); 19 | 20 | //! The nheko D-Bus API version provided by this file. The API version number follows semantic 21 | //! versioning as defined by https://semver.org. 22 | const QVersionNumber dbusApiVersion{1, 0, 1}; 23 | 24 | //! Compare the installed Nheko API to the version that your client app targets to see if they 25 | //! are compatible. 26 | bool 27 | apiVersionIsCompatible(const QVersionNumber &clientAppVersion); 28 | 29 | class RoomInfoItem final : public QObject 30 | { 31 | Q_OBJECT 32 | 33 | public: 34 | RoomInfoItem(const QString &roomId = QString{}, 35 | const QString &alias = QString{}, 36 | const QString &title = QString{}, 37 | const QString &avatarUrl = QString{}, 38 | const int unreadNotifications = 0, 39 | QObject *parent = nullptr); 40 | 41 | RoomInfoItem(const RoomInfoItem &other); 42 | 43 | const QString &roomId() const { return roomId_; } 44 | const QString &alias() const { return alias_; } 45 | const QString &roomName() const { return roomName_; } 46 | const QString &avatarUrl() const { return avatarUrl_; } 47 | int unreadNotifications() const { return unreadNotifications_; } 48 | 49 | RoomInfoItem &operator=(const RoomInfoItem &other); 50 | friend QDBusArgument &operator<<(QDBusArgument &arg, const nheko::dbus::RoomInfoItem &item); 51 | friend const QDBusArgument & 52 | operator>>(const QDBusArgument &arg, nheko::dbus::RoomInfoItem &item); 53 | 54 | private: 55 | QString roomId_; 56 | QString alias_; 57 | QString roomName_; 58 | QString avatarUrl_; 59 | int unreadNotifications_; 60 | }; 61 | 62 | //! Get the nheko D-Bus API version. 63 | QString 64 | apiVersion(); 65 | //! Get the nheko version. 66 | QString 67 | nhekoVersion(); 68 | //! Call this function to get a list of all joined rooms. 69 | QVector 70 | rooms(); 71 | //! Fetch an image using a matrix URI 72 | QImage 73 | image(const QString &uri); 74 | //! Activates a currently joined room. 75 | void 76 | activateRoom(const QString &alias); 77 | //! Joins a room. It is your responsibility to ask for confirmation (if desired). 78 | void 79 | joinRoom(const QString &alias); 80 | //! Starts or activates a direct chat. It is your responsibility to ask for confirmation (if 81 | //! desired). 82 | void 83 | directChat(const QString &userId); 84 | //! Sets the user's status message (if supported by the homeserver). 85 | void 86 | setStatusMessage(const QString &message); 87 | 88 | QDBusArgument & 89 | operator<<(QDBusArgument &arg, const RoomInfoItem &item); 90 | const QDBusArgument & 91 | operator>>(const QDBusArgument &arg, RoomInfoItem &item); 92 | } // nheko::dbus 93 | Q_DECLARE_METATYPE(nheko::dbus::RoomInfoItem) 94 | 95 | QDBusArgument & 96 | operator<<(QDBusArgument &arg, const QImage &image); 97 | const QDBusArgument & 98 | operator>>(const QDBusArgument &arg, QImage &); 99 | 100 | #define NHEKO_DBUS_SERVICE_NAME "im.nheko.Nheko" 101 | 102 | #endif // NHEKODBUSAPI_H 103 | -------------------------------------------------------------------------------- /src/nheko-krunner.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | SPDX-FileCopyrightText: 2022 Loren Burkholder 3 | 4 | SPDX-License-Identifier: LGPL-2.1-or-later 5 | */ 6 | 7 | #include "nheko-krunner.h" 8 | 9 | // KF 10 | #include 11 | #include 12 | 13 | #include 14 | #include 15 | #include 16 | 17 | inline auto logger() 18 | { 19 | return qInfo().noquote() << "[nheko-krunner]"; 20 | } 21 | 22 | NhekoKRunner::NhekoKRunner(QObject *parent, const KPluginMetaData &metadata, const QVariantList &args) 23 | : Plasma::AbstractRunner(parent, metadata, args) 24 | { 25 | setObjectName(QStringLiteral("nheko")); 26 | setMinLetterCount(3); 27 | setPriority(Plasma::AbstractRunner::HighestPriority); 28 | 29 | nheko::dbus::init(); 30 | 31 | connect(this, &Plasma::AbstractRunner::prepare, this, [this] { 32 | if (QDBusConnection::sessionBus().isConnected()) 33 | { 34 | if (nheko::dbus::apiVersionIsCompatible(QVersionNumber::fromString(nheko::dbus::apiVersion()))) 35 | { 36 | m_dbusConnected = true; 37 | m_rooms = nheko::dbus::rooms(); 38 | 39 | if (m_rooms.isEmpty()) 40 | logger() << tr("Connected to nheko, but no rooms were provided."); 41 | else 42 | logger() << tr("Retrieved %n room(s) from nheko.", nullptr, m_rooms.length()); 43 | return; 44 | } 45 | else 46 | logger() << tr("Incompatible nheko API!"); 47 | } 48 | 49 | m_dbusConnected = false; 50 | logger() << tr("Couldn't connect to nheko!"); 51 | }); 52 | } 53 | 54 | NhekoKRunner::~NhekoKRunner() 55 | { 56 | } 57 | 58 | void NhekoKRunner::match(Plasma::RunnerContext &context) 59 | { 60 | if (!m_dbusConnected || m_rooms.isEmpty()) 61 | return; 62 | 63 | bool roomFound{false}; 64 | const auto &input = context.query(); 65 | for (const auto &room : std::as_const(m_rooms)) 66 | { 67 | bool roomMatches{false}; 68 | QStringView matchingContent; 69 | if (room.alias().contains(input, Qt::CaseInsensitive)) 70 | { 71 | roomMatches = true; 72 | matchingContent = room.alias(); 73 | } 74 | else if (room.roomId().contains(input, Qt::CaseInsensitive)) 75 | { 76 | roomMatches = true; 77 | matchingContent = room.roomId(); 78 | } 79 | else if (room.roomName().contains(input, Qt::CaseInsensitive)) 80 | { 81 | roomMatches = true; 82 | matchingContent = room.roomName(); 83 | } 84 | 85 | if (roomMatches) 86 | { 87 | auto text{room.roomName()}; 88 | if ((room.unreadNotifications() > 0) && m_showNotificationCounts) 89 | text.append(QStringLiteral(" (%1)").arg(room.unreadNotifications())); 90 | text.append(QStringLiteral(" (%1)").arg(m_showNotificationCounts)); 91 | 92 | Plasma::QueryMatch match{this}; 93 | match.setText(text); 94 | match.setSubtext(room.alias()); 95 | match.setData(QVariant::fromValue(NhekoAction{.id{room.roomId()}, .actionType{ActionType::OpenRoom}})); 96 | match.setIcon(QIcon{QPixmap::fromImage(nheko::dbus::image(room.avatarUrl()))}); 97 | match.setType(matchingContent.compare(input, Qt::CaseInsensitive) == 0 ? Plasma::QueryMatch::ExactMatch : Plasma::QueryMatch::PossibleMatch); 98 | context.addMatch(match); 99 | 100 | if (room.roomId() == input) 101 | roomFound = true; 102 | } 103 | 104 | if (!context.isValid()) 105 | return; 106 | } 107 | 108 | if (!roomFound) 109 | { 110 | QRegularExpression roomRegex{QStringLiteral("#.+?:.{3,}"), QRegularExpression::CaseInsensitiveOption}; 111 | QRegularExpression userRegex{QStringLiteral("@.+?:.{3,}"), QRegularExpression::CaseInsensitiveOption}; 112 | 113 | if (roomRegex.match(input).hasMatch()) 114 | { 115 | Plasma::QueryMatch m{this}; 116 | m.setSubtext(tr("Join %1").arg(input)); 117 | m.setText(input); 118 | m.setData(QVariant::fromValue(NhekoAction{.id = input, .actionType = ActionType::JoinRoom})); 119 | m.setIcon(QIcon::fromTheme(QStringLiteral("list-add"))); 120 | m.setType(Plasma::QueryMatch::ExactMatch); 121 | context.addMatch(m); 122 | 123 | logger() << tr("Input is a room alias."); 124 | } 125 | else if (userRegex.match(input).hasMatch()) 126 | { 127 | Plasma::QueryMatch m{this}; 128 | m.setSubtext(tr("Direct message %1").arg(input)); 129 | m.setText(input); 130 | m.setData(QVariant::fromValue(NhekoAction{.id = input, .actionType = ActionType::DirectMessage})); 131 | m.setIcon(QIcon::fromTheme(QStringLiteral("user"))); 132 | m.setType(Plasma::QueryMatch::ExactMatch); 133 | context.addMatch(m); 134 | 135 | logger() << tr("Input is a user ID."); 136 | } 137 | } 138 | else 139 | logger() << tr("Found %n matching room(s).", nullptr, context.matches().length()); 140 | } 141 | 142 | void NhekoKRunner::run(const Plasma::RunnerContext &context, const Plasma::QueryMatch &match) 143 | { 144 | Q_UNUSED(context); 145 | 146 | if (QDBusInterface interface{QStringLiteral(NHEKO_DBUS_SERVICE_NAME), QStringLiteral("/")}; interface.isValid()) 147 | { 148 | auto data = match.data().value(); 149 | 150 | switch (data.actionType) 151 | { 152 | case ActionType::OpenRoom: 153 | nheko::dbus::activateRoom(data.id); 154 | break; 155 | case ActionType::JoinRoom: 156 | nheko::dbus::joinRoom(data.id); 157 | break; 158 | case ActionType::DirectMessage: 159 | nheko::dbus::directChat(data.id); 160 | break; 161 | default: 162 | break; 163 | } 164 | } 165 | } 166 | 167 | void NhekoKRunner::reloadConfiguration() 168 | { 169 | KConfigGroup conf = config(); 170 | 171 | m_showNotificationCounts = conf.readEntry(QStringLiteral("showNotificationCounts"), true); 172 | conf.sync(); 173 | } 174 | 175 | K_PLUGIN_CLASS_WITH_JSON(NhekoKRunner, "plasma-runner-nheko-krunner.json") 176 | 177 | // needed for the QObject subclass declared as part of K_EXPORT_PLASMA_RUNNER_WITH_JSON 178 | #include "nheko-krunner.moc" 179 | -------------------------------------------------------------------------------- /src/NhekoDBusApi.cpp: -------------------------------------------------------------------------------- 1 | // SPDX-FileCopyrightText: 2010 David Sansome 2 | // SPDX-FileCopyrightText: 2022 Nheko Contributors 3 | // SPDX-FileCopyrightText: 2023 Nheko Contributors 4 | // 5 | // SPDX-License-Identifier: GPL-3.0-or-later 6 | 7 | #include "NhekoDBusApi.h" 8 | 9 | #include 10 | #include 11 | #include 12 | 13 | namespace nheko::dbus { 14 | void 15 | init() 16 | { 17 | qDBusRegisterMetaType(); 18 | qDBusRegisterMetaType>(); 19 | qDBusRegisterMetaType(); 20 | } 21 | 22 | bool 23 | apiVersionIsCompatible(const QVersionNumber &clientAppVersion) 24 | { 25 | if (clientAppVersion.majorVersion() != nheko::dbus::dbusApiVersion.majorVersion()) 26 | return false; 27 | if (clientAppVersion.minorVersion() > nheko::dbus::dbusApiVersion.minorVersion()) 28 | return false; 29 | if (clientAppVersion.minorVersion() == nheko::dbus::dbusApiVersion.minorVersion() && 30 | clientAppVersion.microVersion() < nheko::dbus::dbusApiVersion.microVersion()) 31 | return false; 32 | 33 | return true; 34 | } 35 | 36 | RoomInfoItem::RoomInfoItem(const QString &roomId, 37 | const QString &alias, 38 | const QString &title, 39 | const QString &avatarUrl, 40 | const int unreadNotifications, 41 | QObject *parent) 42 | : QObject{parent} 43 | , roomId_{roomId} 44 | , alias_{alias} 45 | , roomName_{title} 46 | , avatarUrl_{avatarUrl} 47 | , unreadNotifications_{unreadNotifications} 48 | { 49 | } 50 | 51 | RoomInfoItem::RoomInfoItem(const RoomInfoItem &other) 52 | : QObject{other.parent()} 53 | , roomId_{other.roomId_} 54 | , alias_{other.alias_} 55 | , roomName_{other.roomName_} 56 | , avatarUrl_{other.avatarUrl_} 57 | , unreadNotifications_{other.unreadNotifications_} 58 | { 59 | } 60 | 61 | RoomInfoItem & 62 | RoomInfoItem::operator=(const RoomInfoItem &other) 63 | { 64 | roomId_ = other.roomId_; 65 | alias_ = other.alias_; 66 | roomName_ = other.roomName_; 67 | avatarUrl_ = other.avatarUrl_; 68 | unreadNotifications_ = other.unreadNotifications_; 69 | return *this; 70 | } 71 | 72 | QDBusArgument & 73 | operator<<(QDBusArgument &arg, const RoomInfoItem &item) 74 | { 75 | arg.beginStructure(); 76 | arg << item.roomId_ << item.alias_ << item.roomName_ << item.avatarUrl_ 77 | << item.unreadNotifications_; 78 | arg.endStructure(); 79 | return arg; 80 | } 81 | 82 | const QDBusArgument & 83 | operator>>(const QDBusArgument &arg, RoomInfoItem &item) 84 | { 85 | arg.beginStructure(); 86 | arg >> item.roomId_ >> item.alias_ >> item.roomName_ >> item.avatarUrl_ >> 87 | item.unreadNotifications_; 88 | 89 | arg.endStructure(); 90 | return arg; 91 | } 92 | 93 | QString 94 | apiVersion() 95 | { 96 | if (QDBusInterface interface{QStringLiteral(NHEKO_DBUS_SERVICE_NAME), QStringLiteral("/")}; 97 | interface.isValid()) 98 | return QDBusReply{interface.call(QStringLiteral("apiVersion"))}.value(); 99 | else 100 | return {}; 101 | } 102 | 103 | QString 104 | nhekoVersion() 105 | { 106 | if (QDBusInterface interface{QStringLiteral(NHEKO_DBUS_SERVICE_NAME), QStringLiteral("/")}; 107 | interface.isValid()) 108 | return QDBusReply{interface.call(QStringLiteral("nhekoVersion"))}.value(); 109 | else 110 | return {}; 111 | } 112 | 113 | QVector 114 | rooms() 115 | { 116 | if (QDBusInterface interface{QStringLiteral(NHEKO_DBUS_SERVICE_NAME), QStringLiteral("/")}; 117 | interface.isValid()) 118 | return QDBusReply>{interface.call(QStringLiteral("rooms"))}.value(); 119 | else 120 | return {}; 121 | } 122 | 123 | QImage 124 | image(const QString &mxcuri) 125 | { 126 | if (QDBusInterface interface{QStringLiteral(NHEKO_DBUS_SERVICE_NAME), QStringLiteral("/")}; 127 | interface.isValid()) 128 | return QDBusReply{interface.call(QStringLiteral("image"), mxcuri)}.value(); 129 | else 130 | return {}; 131 | } 132 | 133 | void 134 | activateRoom(const QString &alias) 135 | { 136 | if (QDBusInterface interface{QStringLiteral(NHEKO_DBUS_SERVICE_NAME), QStringLiteral("/")}; 137 | interface.isValid()) 138 | interface.call(QDBus::NoBlock, QStringLiteral("activateRoom"), alias); 139 | } 140 | 141 | void 142 | joinRoom(const QString &alias) 143 | { 144 | if (QDBusInterface interface{QStringLiteral(NHEKO_DBUS_SERVICE_NAME), QStringLiteral("/")}; 145 | interface.isValid()) 146 | interface.call(QDBus::NoBlock, QStringLiteral("joinRoom"), alias); 147 | } 148 | 149 | void 150 | directChat(const QString &userId) 151 | { 152 | if (QDBusInterface interface{QStringLiteral(NHEKO_DBUS_SERVICE_NAME), QStringLiteral("/")}; 153 | interface.isValid()) 154 | interface.call(QDBus::NoBlock, QStringLiteral("directChat"), userId); 155 | } 156 | 157 | void 158 | setStatusMessage(const QString &message) 159 | { 160 | if (QDBusInterface interface{QStringLiteral(NHEKO_DBUS_SERVICE_NAME), QStringLiteral("/")}; 161 | interface.isValid()) 162 | interface.call(QDBus::NoBlock, QStringLiteral("setStatusMessage"), message); 163 | } 164 | 165 | } // nheko::dbus 166 | 167 | /** 168 | * Automatic marshaling of a QImage for org.freedesktop.Notifications.Notify 169 | * 170 | * This function is heavily based on a function from the Clementine project (see 171 | * http://www.clementine-player.org) and licensed under the GNU General Public 172 | * License, version 3 or later. 173 | * 174 | * SPDX-FileCopyrightText: 2010 David Sansome 175 | */ 176 | QDBusArgument & 177 | operator<<(QDBusArgument &arg, const QImage &image) 178 | { 179 | if (image.isNull()) { 180 | arg.beginStructure(); 181 | arg << 0 << 0 << 0 << false << 0 << 0 << QByteArray(); 182 | arg.endStructure(); 183 | return arg; 184 | } 185 | 186 | QImage i = image.height() > 100 || image.width() > 100 187 | ? image.scaledToHeight(100, Qt::SmoothTransformation) 188 | : image; 189 | i = std::move(i).convertToFormat(QImage::Format_RGBA8888); 190 | 191 | arg.beginStructure(); 192 | arg << i.width(); 193 | arg << i.height(); 194 | arg << i.bytesPerLine(); 195 | arg << i.hasAlphaChannel(); 196 | int channels = i.hasAlphaChannel() ? 4 : 3; 197 | arg << i.depth() / channels; 198 | arg << channels; 199 | arg << QByteArray(reinterpret_cast(i.bits()), static_cast(i.sizeInBytes())); 200 | arg.endStructure(); 201 | 202 | return arg; 203 | } 204 | 205 | // This function, however, was merely reverse-engineered from the above function 206 | // and is not from the Clementine project. 207 | const QDBusArgument & 208 | operator>>(const QDBusArgument &arg, QImage &image) 209 | { 210 | // garbage is used as a sort of /dev/null 211 | int width, height, garbage; 212 | QByteArray bits; 213 | 214 | arg.beginStructure(); 215 | arg >> width >> height >> garbage >> garbage >> garbage >> garbage >> bits; 216 | arg.endStructure(); 217 | 218 | // Unfortunately, this copy-and-detach is necessary to ensure that the source buffer 219 | // is copied properly. If anybody finds a better solution, please implement it. 220 | auto temp = 221 | QImage(reinterpret_cast(bits.data()), width, height, QImage::Format_RGBA8888); 222 | image = temp; 223 | image.detach(); 224 | 225 | return arg; 226 | } 227 | -------------------------------------------------------------------------------- /LICENSES/LGPL-2.1-or-later.txt: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | 3 | Version 2.1, February 1999 4 | 5 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 6 | 7 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 8 | 9 | Everyone is permitted to copy and distribute verbatim copies of this license 10 | document, but changing it is not allowed. 11 | 12 | [This is the first released version of the Lesser GPL. It also counts as the 13 | successor of the GNU Library Public License, version 2, hence the version 14 | number 2.1.] 15 | 16 | Preamble 17 | 18 | The licenses for most software are designed to take away your freedom to share 19 | and change it. By contrast, the GNU General Public Licenses are intended to 20 | guarantee your freedom to share and change free software--to make sure the 21 | software is free for all its users. 22 | 23 | This license, the Lesser General Public License, applies to some specially 24 | designated software packages--typically libraries--of the Free Software Foundation 25 | and other authors who decide to use it. You can use it too, but we suggest 26 | you first think carefully about whether this license or the ordinary General 27 | Public License is the better strategy to use in any particular case, based 28 | on the explanations below. 29 | 30 | When we speak of free software, we are referring to freedom of use, not price. 31 | Our General Public Licenses are designed to make sure that you have the freedom 32 | to distribute copies of free software (and charge for this service if you 33 | wish); that you receive source code or can get it if you want it; that you 34 | can change the software and use pieces of it in new free programs; and that 35 | you are informed that you can do these things. 36 | 37 | To protect your rights, we need to make restrictions that forbid distributors 38 | to deny you these rights or to ask you to surrender these rights. These restrictions 39 | translate to certain responsibilities for you if you distribute copies of 40 | the library or if you modify it. 41 | 42 | For example, if you distribute copies of the library, whether gratis or for 43 | a fee, you must give the recipients all the rights that we gave you. You must 44 | make sure that they, too, receive or can get the source code. If you link 45 | other code with the library, you must provide complete object files to the 46 | recipients, so that they can relink them with the library after making changes 47 | to the library and recompiling it. And you must show them these terms so they 48 | know their rights. 49 | 50 | We protect your rights with a two-step method: (1) we copyright the library, 51 | and (2) we offer you this license, which gives you legal permission to copy, 52 | distribute and/or modify the library. 53 | 54 | To protect each distributor, we want to make it very clear that there is no 55 | warranty for the free library. Also, if the library is modified by someone 56 | else and passed on, the recipients should know that what they have is not 57 | the original version, so that the original author's reputation will not be 58 | affected by problems that might be introduced by others. 59 | 60 | Finally, software patents pose a constant threat to the existence of any free 61 | program. We wish to make sure that a company cannot effectively restrict the 62 | users of a free program by obtaining a restrictive license from a patent holder. 63 | Therefore, we insist that any patent license obtained for a version of the 64 | library must be consistent with the full freedom of use specified in this 65 | license. 66 | 67 | Most GNU software, including some libraries, is covered by the ordinary GNU 68 | General Public License. This license, the GNU Lesser General Public License, 69 | applies to certain designated libraries, and is quite different from the ordinary 70 | General Public License. We use this license for certain libraries in order 71 | to permit linking those libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using a shared 74 | library, the combination of the two is legally speaking a combined work, a 75 | derivative of the original library. The ordinary General Public License therefore 76 | permits such linking only if the entire combination fits its criteria of freedom. 77 | The Lesser General Public License permits more lax criteria for linking other 78 | code with the library. 79 | 80 | We call this license the "Lesser" General Public License because it does Less 81 | to protect the user's freedom than the ordinary General Public License. It 82 | also provides other free software developers Less of an advantage over competing 83 | non-free programs. These disadvantages are the reason we use the ordinary 84 | General Public License for many libraries. However, the Lesser license provides 85 | advantages in certain special circumstances. 86 | 87 | For example, on rare occasions, there may be a special need to encourage the 88 | widest possible use of a certain library, so that it becomes a de-facto standard. 89 | To achieve this, non-free programs must be allowed to use the library. A more 90 | frequent case is that a free library does the same job as widely used non-free 91 | libraries. In this case, there is little to gain by limiting the free library 92 | to free software only, so we use the Lesser General Public License. 93 | 94 | In other cases, permission to use a particular library in non-free programs 95 | enables a greater number of people to use a large body of free software. For 96 | example, permission to use the GNU C Library in non-free programs enables 97 | many more people to use the whole GNU operating system, as well as its variant, 98 | the GNU/Linux operating system. 99 | 100 | Although the Lesser General Public License is Less protective of the users' 101 | freedom, it does ensure that the user of a program that is linked with the 102 | Library has the freedom and the wherewithal to run that program using a modified 103 | version of the Library. 104 | 105 | The precise terms and conditions for copying, distribution and modification 106 | follow. Pay close attention to the difference between a "work based on the 107 | library" and a "work that uses the library". The former contains code derived 108 | from the library, whereas the latter must be combined with the library in 109 | order to run. 110 | 111 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 112 | 113 | 0. This License Agreement applies to any software library or other program 114 | which contains a notice placed by the copyright holder or other authorized 115 | party saying it may be distributed under the terms of this Lesser General 116 | Public License (also called "this License"). Each licensee is addressed as 117 | "you". 118 | 119 | A "library" means a collection of software functions and/or data prepared 120 | so as to be conveniently linked with application programs (which use some 121 | of those functions and data) to form executables. 122 | 123 | The "Library", below, refers to any such software library or work which has 124 | been distributed under these terms. A "work based on the Library" means either 125 | the Library or any derivative work under copyright law: that is to say, a 126 | work containing the Library or a portion of it, either verbatim or with modifications 127 | and/or translated straightforwardly into another language. (Hereinafter, translation 128 | is included without limitation in the term "modification".) 129 | 130 | "Source code" for a work means the preferred form of the work for making modifications 131 | to it. For a library, complete source code means all the source code for all 132 | modules it contains, plus any associated interface definition files, plus 133 | the scripts used to control compilation and installation of the library. 134 | 135 | Activities other than copying, distribution and modification are not covered 136 | by this License; they are outside its scope. The act of running a program 137 | using the Library is not restricted, and output from such a program is covered 138 | only if its contents constitute a work based on the Library (independent of 139 | the use of the Library in a tool for writing it). Whether that is true depends 140 | on what the Library does and what the program that uses the Library does. 141 | 142 | 1. You may copy and distribute verbatim copies of the Library's complete source 143 | code as you receive it, in any medium, provided that you conspicuously and 144 | appropriately publish on each copy an appropriate copyright notice and disclaimer 145 | of warranty; keep intact all the notices that refer to this License and to 146 | the absence of any warranty; and distribute a copy of this License along with 147 | the Library. 148 | 149 | You may charge a fee for the physical act of transferring a copy, and you 150 | may at your option offer warranty protection in exchange for a fee. 151 | 152 | 2. You may modify your copy or copies of the Library or any portion of it, 153 | thus forming a work based on the Library, and copy and distribute such modifications 154 | or work under the terms of Section 1 above, provided that you also meet all 155 | of these conditions: 156 | 157 | a) The modified work must itself be a software library. 158 | 159 | b) You must cause the files modified to carry prominent notices stating that 160 | you changed the files and the date of any change. 161 | 162 | c) You must cause the whole of the work to be licensed at no charge to all 163 | third parties under the terms of this License. 164 | 165 | d) If a facility in the modified Library refers to a function or a table of 166 | data to be supplied by an application program that uses the facility, other 167 | than as an argument passed when the facility is invoked, then you must make 168 | a good faith effort to ensure that, in the event an application does not supply 169 | such function or table, the facility still operates, and performs whatever 170 | part of its purpose remains meaningful. 171 | 172 | (For example, a function in a library to compute square roots has a purpose 173 | that is entirely well-defined independent of the application. Therefore, Subsection 174 | 2d requires that any application-supplied function or table used by this function 175 | must be optional: if the application does not supply it, the square root function 176 | must still compute square roots.) 177 | 178 | These requirements apply to the modified work as a whole. If identifiable 179 | sections of that work are not derived from the Library, and can be reasonably 180 | considered independent and separate works in themselves, then this License, 181 | and its terms, do not apply to those sections when you distribute them as 182 | separate works. But when you distribute the same sections as part of a whole 183 | which is a work based on the Library, the distribution of the whole must be 184 | on the terms of this License, whose permissions for other licensees extend 185 | to the entire whole, and thus to each and every part regardless of who wrote 186 | it. 187 | 188 | Thus, it is not the intent of this section to claim rights or contest your 189 | rights to work written entirely by you; rather, the intent is to exercise 190 | the right to control the distribution of derivative or collective works based 191 | on the Library. 192 | 193 | In addition, mere aggregation of another work not based on the Library with 194 | the Library (or with a work based on the Library) on a volume of a storage 195 | or distribution medium does not bring the other work under the scope of this 196 | License. 197 | 198 | 3. You may opt to apply the terms of the ordinary GNU General Public License 199 | instead of this License to a given copy of the Library. To do this, you must 200 | alter all the notices that refer to this License, so that they refer to the 201 | ordinary GNU General Public License, version 2, instead of to this License. 202 | (If a newer version than version 2 of the ordinary GNU General Public License 203 | has appeared, then you can specify that version instead if you wish.) Do not 204 | make any other change in these notices. 205 | 206 | Once this change is made in a given copy, it is irreversible for that copy, 207 | so the ordinary GNU General Public License applies to all subsequent copies 208 | and derivative works made from that copy. 209 | 210 | This option is useful when you wish to copy part of the code of the Library 211 | into a program that is not a library. 212 | 213 | 4. You may copy and distribute the Library (or a portion or derivative of 214 | it, under Section 2) in object code or executable form under the terms of 215 | Sections 1 and 2 above provided that you accompany it with the complete corresponding 216 | machine-readable source code, which must be distributed under the terms of 217 | Sections 1 and 2 above on a medium customarily used for software interchange. 218 | 219 | If distribution of object code is made by offering access to copy from a designated 220 | place, then offering equivalent access to copy the source code from the same 221 | place satisfies the requirement to distribute the source code, even though 222 | third parties are not compelled to copy the source along with the object code. 223 | 224 | 5. A program that contains no derivative of any portion of the Library, but 225 | is designed to work with the Library by being compiled or linked with it, 226 | is called a "work that uses the Library". Such a work, in isolation, is not 227 | a derivative work of the Library, and therefore falls outside the scope of 228 | this License. 229 | 230 | However, linking a "work that uses the Library" with the Library creates an 231 | executable that is a derivative of the Library (because it contains portions 232 | of the Library), rather than a "work that uses the library". The executable 233 | is therefore covered by this License. Section 6 states terms for distribution 234 | of such executables. 235 | 236 | When a "work that uses the Library" uses material from a header file that 237 | is part of the Library, the object code for the work may be a derivative work 238 | of the Library even though the source code is not. Whether this is true is 239 | especially significant if the work can be linked without the Library, or if 240 | the work is itself a library. The threshold for this to be true is not precisely 241 | defined by law. 242 | 243 | If such an object file uses only numerical parameters, data structure layouts 244 | and accessors, and small macros and small inline functions (ten lines or less 245 | in length), then the use of the object file is unrestricted, regardless of 246 | whether it is legally a derivative work. (Executables containing this object 247 | code plus portions of the Library will still fall under Section 6.) 248 | 249 | Otherwise, if the work is a derivative of the Library, you may distribute 250 | the object code for the work under the terms of Section 6. Any executables 251 | containing that work also fall under Section 6, whether or not they are linked 252 | directly with the Library itself. 253 | 254 | 6. As an exception to the Sections above, you may also combine or link a "work 255 | that uses the Library" with the Library to produce a work containing portions 256 | of the Library, and distribute that work under terms of your choice, provided 257 | that the terms permit modification of the work for the customer's own use 258 | and reverse engineering for debugging such modifications. 259 | 260 | You must give prominent notice with each copy of the work that the Library 261 | is used in it and that the Library and its use are covered by this License. 262 | You must supply a copy of this License. If the work during execution displays 263 | copyright notices, you must include the copyright notice for the Library among 264 | them, as well as a reference directing the user to the copy of this License. 265 | Also, you must do one of these things: 266 | 267 | a) Accompany the work with the complete corresponding machine-readable source 268 | code for the Library including whatever changes were used in the work (which 269 | must be distributed under Sections 1 and 2 above); and, if the work is an 270 | executable linked with the Library, with the complete machine-readable "work 271 | that uses the Library", as object code and/or source code, so that the user 272 | can modify the Library and then relink to produce a modified executable containing 273 | the modified Library. (It is understood that the user who changes the contents 274 | of definitions files in the Library will not necessarily be able to recompile 275 | the application to use the modified definitions.) 276 | 277 | b) Use a suitable shared library mechanism for linking with the Library. A 278 | suitable mechanism is one that (1) uses at run time a copy of the library 279 | already present on the user's computer system, rather than copying library 280 | functions into the executable, and (2) will operate properly with a modified 281 | version of the library, if the user installs one, as long as the modified 282 | version is interface-compatible with the version that the work was made with. 283 | 284 | c) Accompany the work with a written offer, valid for at least three years, 285 | to give the same user the materials specified in Subsection 6a, above, for 286 | a charge no more than the cost of performing this distribution. 287 | 288 | d) If distribution of the work is made by offering access to copy from a designated 289 | place, offer equivalent access to copy the above specified materials from 290 | the same place. 291 | 292 | e) Verify that the user has already received a copy of these materials or 293 | that you have already sent this user a copy. 294 | 295 | For an executable, the required form of the "work that uses the Library" must 296 | include any data and utility programs needed for reproducing the executable 297 | from it. However, as a special exception, the materials to be distributed 298 | need not include anything that is normally distributed (in either source or 299 | binary form) with the major components (compiler, kernel, and so on) of the 300 | operating system on which the executable runs, unless that component itself 301 | accompanies the executable. 302 | 303 | It may happen that this requirement contradicts the license restrictions of 304 | other proprietary libraries that do not normally accompany the operating system. 305 | Such a contradiction means you cannot use both them and the Library together 306 | in an executable that you distribute. 307 | 308 | 7. You may place library facilities that are a work based on the Library side-by-side 309 | in a single library together with other library facilities not covered by 310 | this License, and distribute such a combined library, provided that the separate 311 | distribution of the work based on the Library and of the other library facilities 312 | is otherwise permitted, and provided that you do these two things: 313 | 314 | a) Accompany the combined library with a copy of the same work based on the 315 | Library, uncombined with any other library facilities. This must be distributed 316 | under the terms of the Sections above. 317 | 318 | b) Give prominent notice with the combined library of the fact that part of 319 | it is a work based on the Library, and explaining where to find the accompanying 320 | uncombined form of the same work. 321 | 322 | 8. You may not copy, modify, sublicense, link with, or distribute the Library 323 | except as expressly provided under this License. Any attempt otherwise to 324 | copy, modify, sublicense, link with, or distribute the Library is void, and 325 | will automatically terminate your rights under this License. However, parties 326 | who have received copies, or rights, from you under this License will not 327 | have their licenses terminated so long as such parties remain in full compliance. 328 | 329 | 9. You are not required to accept this License, since you have not signed 330 | it. However, nothing else grants you permission to modify or distribute the 331 | Library or its derivative works. These actions are prohibited by law if you 332 | do not accept this License. Therefore, by modifying or distributing the Library 333 | (or any work based on the Library), you indicate your acceptance of this License 334 | to do so, and all its terms and conditions for copying, distributing or modifying 335 | the Library or works based on it. 336 | 337 | 10. Each time you redistribute the Library (or any work based on the Library), 338 | the recipient automatically receives a license from the original licensor 339 | to copy, distribute, link with or modify the Library subject to these terms 340 | and conditions. You may not impose any further restrictions on the recipients' 341 | exercise of the rights granted herein. You are not responsible for enforcing 342 | compliance by third parties with this License. 343 | 344 | 11. If, as a consequence of a court judgment or allegation of patent infringement 345 | or for any other reason (not limited to patent issues), conditions are imposed 346 | on you (whether by court order, agreement or otherwise) that contradict the 347 | conditions of this License, they do not excuse you from the conditions of 348 | this License. If you cannot distribute so as to satisfy simultaneously your 349 | obligations under this License and any other pertinent obligations, then as 350 | a consequence you may not distribute the Library at all. For example, if a 351 | patent license would not permit royalty-free redistribution of the Library 352 | by all those who receive copies directly or indirectly through you, then the 353 | only way you could satisfy both it and this License would be to refrain entirely 354 | from distribution of the Library. 355 | 356 | If any portion of this section is held invalid or unenforceable under any 357 | particular circumstance, the balance of the section is intended to apply, 358 | and the section as a whole is intended to apply in other circumstances. 359 | 360 | It is not the purpose of this section to induce you to infringe any patents 361 | or other property right claims or to contest validity of any such claims; 362 | this section has the sole purpose of protecting the integrity of the free 363 | software distribution system which is implemented by public license practices. 364 | Many people have made generous contributions to the wide range of software 365 | distributed through that system in reliance on consistent application of that 366 | system; it is up to the author/donor to decide if he or she is willing to 367 | distribute software through any other system and a licensee cannot impose 368 | that choice. 369 | 370 | This section is intended to make thoroughly clear what is believed to be a 371 | consequence of the rest of this License. 372 | 373 | 12. If the distribution and/or use of the Library is restricted in certain 374 | countries either by patents or by copyrighted interfaces, the original copyright 375 | holder who places the Library under this License may add an explicit geographical 376 | distribution limitation excluding those countries, so that distribution is 377 | permitted only in or among countries not thus excluded. In such case, this 378 | License incorporates the limitation as if written in the body of this License. 379 | 380 | 13. The Free Software Foundation may publish revised and/or new versions of 381 | the Lesser General Public License from time to time. Such new versions will 382 | be similar in spirit to the present version, but may differ in detail to address 383 | new problems or concerns. 384 | 385 | Each version is given a distinguishing version number. If the Library specifies 386 | a version number of this License which applies to it and "any later version", 387 | you have the option of following the terms and conditions either of that version 388 | or of any later version published by the Free Software Foundation. If the 389 | Library does not specify a license version number, you may choose any version 390 | ever published by the Free Software Foundation. 391 | 392 | 14. If you wish to incorporate parts of the Library into other free programs 393 | whose distribution conditions are incompatible with these, write to the author 394 | to ask for permission. For software which is copyrighted by the Free Software 395 | Foundation, write to the Free Software Foundation; we sometimes make exceptions 396 | for this. Our decision will be guided by the two goals of preserving the free 397 | status of all derivatives of our free software and of promoting the sharing 398 | and reuse of software generally. 399 | 400 | NO WARRANTY 401 | 402 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR 403 | THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE 404 | STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY 405 | "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, 406 | BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 407 | FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE 408 | OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 409 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 410 | 411 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 412 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE 413 | THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 414 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE 415 | OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA 416 | OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES 417 | OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH 418 | HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 419 | END OF TERMS AND CONDITIONS 420 | 421 | How to Apply These Terms to Your New Libraries 422 | 423 | If you develop a new library, and you want it to be of the greatest possible 424 | use to the public, we recommend making it free software that everyone can 425 | redistribute and change. You can do so by permitting redistribution under 426 | these terms (or, alternatively, under the terms of the ordinary General Public 427 | License). 428 | 429 | To apply these terms, attach the following notices to the library. It is safest 430 | to attach them to the start of each source file to most effectively convey 431 | the exclusion of warranty; and each file should have at least the "copyright" 432 | line and a pointer to where the full notice is found. 433 | 434 | 435 | 436 | Copyright (C) 437 | 438 | This library is free software; you can redistribute it and/or modify it under 439 | the terms of the GNU Lesser General Public License as published by the Free 440 | Software Foundation; either version 2.1 of the License, or (at your option) 441 | any later version. 442 | 443 | This library is distributed in the hope that it will be useful, but WITHOUT 444 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 445 | FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 446 | details. 447 | 448 | You should have received a copy of the GNU Lesser General Public License along 449 | with this library; if not, write to the Free Software Foundation, Inc., 51 450 | Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 451 | 452 | Also add information on how to contact you by electronic and paper mail. 453 | 454 | You should also get your employer (if you work as a programmer) or your school, 455 | if any, to sign a "copyright disclaimer" for the library, if necessary. Here 456 | is a sample; alter the names: 457 | 458 | Yoyodyne, Inc., hereby disclaims all copyright interest in 459 | 460 | the library `Frob' (a library for tweaking knobs) written 461 | 462 | by James Random Hacker. 463 | 464 | < signature of Ty Coon > , 1 April 1990 465 | 466 | Ty Coon, President of Vice 467 | 468 | That's all there is to it! 469 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------