src/ShellIntegration.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // LameXP - Audio Encoder Front-End
   3 // Copyright (C) 2004-2017 LoRd_MuldeR <MuldeR2@GMX.de>
   4 //
   5 // This program is free software; you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation; either version 2 of the License, or
   8 // (at your option) any later version, but always including the *additional*
   9 // restrictions defined in the "License.txt" file.
  10 //
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License along
  17 // with this program; if not, write to the Free Software Foundation, Inc.,
  18 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 //
  20 // http://www.gnu.org/licenses/gpl-2.0.txt
  21 ///////////////////////////////////////////////////////////////////////////////
  22
  23 #include "ShellIntegration.h"
  24
  25 //Internal
  26 #include "Global.h"
  27 #include "Registry_Decoder.h"
  28
  29 //MUtils
  30 #include <MUtils/Global.h>
  31 #include <MUtils/Exception.h>
  32 #include <MUtils/OSSupport.h>
  33 #include <MUtils/Registry.h>
  34
  35 //Qt
  36 #include <QString>
  37 #include <QStringList>
  38 #include <QRegExp>
  39 #include <QApplication>
  40 #include <QFileInfo>
  41 #include <QDir>
  42 #include <QMutexLocker>
  43 #include <QtConcurrentRun>
  44
  45 //Const
  46 static const char *g_lamexpShellAction = "ConvertWithLameXP";
  47 static const char *g_lamexpFileType    = "LameXP.SupportedAudioFile";
  48
  49 //State values
  50 static const int STATE_ENABLED =  1;
  51 static const int STATE_UNKNOWN =  0;
  52 static const int STATE_DISABLD = -1;
  53
  54 //State
  55 QAtomicInt ShellIntegration::m_state(STATE_UNKNOWN);
  56
  57 //Macros
  58 #define REG_WRITE_STRING(KEY, STR) RegSetValueEx(key, NULL, NULL, REG_SZ, reinterpret_cast<const BYTE*>(STR.utf16()), (STR.size() + 1) * sizeof(wchar_t))
  59
  60 ////////////////////////////////////////////////////////////
  61 // Constructor
  62 ////////////////////////////////////////////////////////////
  63
  64 ShellIntegration::ShellIntegration(void)
  65 {
  66         MUTILS_THROW("Cannot create instance of this class, sorry!");
  67 }
  68
  69 ////////////////////////////////////////////////////////////
  70 // Public Functions
  71 ////////////////////////////////////////////////////////////
  72
  73 void ShellIntegration::install(bool async)
  74 {
  75         //Install asynchronously
  76         if(async)
  77         {
  78                 QFuture<void>(QtConcurrent::run(install, false));
  79                 return;
  80         }
  81
  82         //Checking
  83         const int originalState = m_state.fetchAndStoreOrdered(STATE_ENABLED);
  84         if(originalState == STATE_ENABLED)
  85         {
  86                 return; /*already enabled, don't enable again!*/
  87         }
  88
  89         //Init some consts
  90         const QString lamexpFileType(g_lamexpFileType);
  91         const QString lamexpFileInfo(tr("Audio File supported by LameXP"));
  92         const QString lamexpShellText(tr("Convert this file with LameXP v%1").arg(QString().sprintf("%d.%02d", lamexp_version_major(), lamexp_version_minor())));
  93         const QString lamexpShellCommand = QString("\"%1\" \"--add=%2\"").arg(QDir::toNativeSeparators(QFileInfo(QApplication::applicationFilePath()).canonicalFilePath()), "%1");
  94         const QString lamexpShellAction(g_lamexpShellAction);
  95
  96         //Register the LameXP file type
  97         bool ok[4] = {false, false, false, false};
  98         ok[0] = MUtils::Registry::reg_value_write(MUtils::Registry::root_user, QString("Software\\Classes\\%1")                    .arg(lamexpFileType),                    QString(), lamexpFileInfo);
  99         ok[1] = MUtils::Registry::reg_value_write(MUtils::Registry::root_user, QString("Software\\Classes\\%1\\shell")             .arg(lamexpFileType),                    QString(), lamexpShellAction);
 100         ok[2] = MUtils::Registry::reg_value_write(MUtils::Registry::root_user, QString("Software\\Classes\\%1\\shell\\%2")         .arg(lamexpFileType, lamexpShellAction), QString(), lamexpShellText);
 101         ok[3] = MUtils::Registry::reg_value_write(MUtils::Registry::root_user, QString("Software\\Classes\\%1\\shell\\%2\\command").arg(lamexpFileType, lamexpShellAction), QString(), lamexpShellCommand);
 102         if(!(ok[0] && ok[1] && ok[2] && ok[3]))
 103         {
 104                 m_state.fetchAndStoreOrdered(originalState);
 105                 qWarning("Failed to register the LameXP file type!");
 106                 return;
 107         }
 108
 109         //Detect supported file types
 110         QStringList types;
 111         initializeTypes(lamexpFileType, lamexpShellAction, types);
 112
 113         //Add LameXP shell action to all supported file types
 114         for(QStringList::ConstIterator iter = types.constBegin(); iter != types.constEnd(); iter++)
 115         {
 116                 MUtils::Registry::reg_value_write(MUtils::Registry::root_user, QString("Software\\Classes\\%1\\shell\\%2")         .arg((*iter), lamexpShellAction), QString(), lamexpShellText);
 117                 MUtils::Registry::reg_value_write(MUtils::Registry::root_user, QString("Software\\Classes\\%1\\shell\\%2\\command").arg((*iter), lamexpShellAction), QString(), lamexpShellCommand);
 118         }
 119
 120         //Shell notification
 121         MUtils::OS::shell_change_notification();
 122 }
 123
 124 void ShellIntegration::remove(bool async)
 125 {
 126         //Remove asynchronously
 127         if(async)
 128         {
 129                 QFuture<void>(QtConcurrent::run(remove, false));
 130                 return;
 131         }
 132
 133         //Checking
 134         const int originalState = m_state.fetchAndStoreOrdered(STATE_DISABLD);
 135         if(originalState == STATE_DISABLD)
 136         {
 137                 return; /*already enabled, don't enable again!*/
 138         }
 139
 140         //Init some consts
 141         const QString lamexpFileType(g_lamexpFileType);
 142         const QString lamexpShellAction(g_lamexpShellAction);
 143
 144         //Initialization
 145         QStringList fileTypes;
 146
 147         //Find all registered file types
 148         if(!MUtils::Registry::reg_enum_subkeys(MUtils::Registry::root_user, "Software\\Classes", fileTypes))
 149         {
 150                 m_state.fetchAndStoreOrdered(originalState);
 151                 qWarning("Failed to enumerate file types!");
 152                 return;
 153         }
 154
 155         //Remove shell action from all file types
 156         for(QStringList::ConstIterator iter = fileTypes.constBegin(); iter != fileTypes.constEnd(); iter++)
 157         {
 158                 //Remove LameXP-specific types altogether
 159                 if(iter->startsWith('.'))
 160                 {
 161                         QString currentFileType;
 162                         if(MUtils::Registry::reg_value_read(MUtils::Registry::root_user, QString("Software\\Classes\\%1").arg(*iter), QString(), currentFileType))
 163                         {
 164                                 if(currentFileType.compare(lamexpFileType, Qt::CaseInsensitive) == 0)
 165                                 {
 166                                         MUtils::Registry::reg_key_delete(MUtils::Registry::root_user, QString("Software\\Classes\\%1").arg(*iter));
 167                                         continue;
 168                                 }
 169                         }
 170                 }
 171
 172                 //Remove shell action for non-LameXP types
 173                 MUtils::Registry::reg_key_delete(MUtils::Registry::root_user, QString("Software\\Classes\\%1\\shell\\%2").arg((*iter), lamexpShellAction));
 174
 175                 //Remove from sub-tree too
 176                 QStringList subTypes;
 177                 if(MUtils::Registry::reg_enum_subkeys(MUtils::Registry::root_user, QString("Software\\Classes\\%1").arg(*iter), subTypes))
 178                 {
 179                         for(QStringList::ConstIterator iter2 = subTypes.constBegin(); iter2 != subTypes.constEnd(); iter2++)
 180                         {
 181                                 MUtils::Registry::reg_key_delete(MUtils::Registry::root_user, QString("Software\\Classes\\%1\\%2\\shell\\%3").arg((*iter), (*iter2), lamexpShellAction));
 182                         }
 183                 }
 184         }
 185
 186
 187         //Unregister LameXP file type
 188         MUtils::Registry::reg_key_delete(MUtils::Registry::root_user, QString("Software\\Classes\\%1").arg(lamexpFileType));
 189
 190         //Shell notification
 191         MUtils::OS::shell_change_notification();
 192 }
 193
 194 ////////////////////////////////////////////////////////////
 195 // Private Functions
 196 ////////////////////////////////////////////////////////////
 197
 198 void ShellIntegration::initializeTypes(const QString &lamexpFileType, const QString &lamexpShellAction, QStringList &nativeTypes)
 199 {
 200         nativeTypes.clear();
 201         const QString progId = "Progid";
 202
 203         //Map supported extensions to native types
 204         const QStringList &supportedExts = DecoderRegistry::getSupportedExts();
 205         for(QStringList::ConstIterator iter = supportedExts.constBegin(); iter != supportedExts.constEnd(); iter++)
 206         {
 207                 const QString currentExt = (*iter).mid(1).trimmed(); /*remove leading asterisk*/
 208                 if(currentExt.isEmpty() || (!currentExt.startsWith('.')))
 209                 {
 210                         qWarning("Invalid file extension '%s' encountered -> skipping!", currentExt);
 211                         continue;
 212                 }
 213
 214                 bool hasExistingType = false;
 215                 QString currentType;
 216                 if(MUtils::Registry::reg_key_exists(MUtils::Registry::root_classes, currentExt))
 217                 {
 218                         if(MUtils::Registry::reg_value_read(MUtils::Registry::root_classes, currentExt, QString(), currentType))
 219                         {
 220                                 currentType = QDir::toNativeSeparators(currentType);
 221                                 if((currentType.compare(lamexpFileType, Qt::CaseInsensitive) != 0) && (!nativeTypes.contains(currentType, Qt::CaseInsensitive)))
 222                                 {
 223                                         nativeTypes.append(currentType);
 224                                         hasExistingType = true;
 225                                 }
 226                         }
 227                 }
 228                 if(!hasExistingType)
 229                 {
 230                         currentType = lamexpFileType;
 231                         MUtils::Registry::reg_value_write(MUtils::Registry::root_user, QString("Software\\Classes\\%1").arg(currentExt), QString(), lamexpFileType);
 232                 }
 233
 234                 const QString userChoiceKey = QString("Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\FileExts\\%1\\UserChoice").arg(currentExt);
 235                 if(MUtils::Registry::reg_key_exists(MUtils::Registry::root_user, userChoiceKey))
 236                 {
 237                         if(MUtils::Registry::reg_value_read(MUtils::Registry::root_user, userChoiceKey, progId, currentType))
 238                         {
 239                                 currentType = QDir::toNativeSeparators(currentType);
 240                                 if((currentType.compare(lamexpFileType, Qt::CaseInsensitive) != 0) && (!nativeTypes.contains(currentType, Qt::CaseInsensitive)))
 241                                 {
 242                                         nativeTypes.append(currentType);
 243                                 }
 244                         }
 245                 }
 246
 247                 QStringList progids;
 248                 if(MUtils::Registry::reg_enum_values(MUtils::Registry::root_user, QString("Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\FileExts\\%1\\OpenWithProgids").arg(currentExt), progids))
 249                 {
 250                         for(QStringList::ConstIterator iter2 = progids.constBegin(); iter2 != progids.constEnd(); iter2++)
 251                         {
 252                                 currentType = QDir::toNativeSeparators(currentType);
 253                                 if((iter2->compare(lamexpFileType, Qt::CaseInsensitive) != 0) && (!nativeTypes.contains((*iter2), Qt::CaseInsensitive)))
 254                                 {
 255                                         nativeTypes.append(*iter2);
 256                                 }
 257                         }
 258                 }
 259         }
 260 }