nt/addpm.c

   1 /* Add entries to the GNU Emacs Program Manager folder.
   2    Copyright (C) 1995, 2001-2013 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Emacs.
   5
   6 GNU Emacs is free software: you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation, either version 3 of the License, or
   9 (at your option) any later version.
  10
  11 GNU Emacs 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
  17 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 /****************************************************************************
  20  *
  21  * Program: addpm       (adds emacs to the Windows program manager)
  22  *
  23  * Usage:
  24  *      argv[1] = install path for emacs
  25  *
  26  * argv[2] used to be an optional argument for setting the icon.
  27  * But now Emacs has a professional looking icon of its own.
  28  * If users really want to change it, they can go into the settings of
  29  * the shortcut that is created and do it there.
  30  */
  31
  32 /* Use parts of shell API that were introduced by the merge of IE4
  33    into the desktop shell.  If Windows 95 or NT4 users do not have IE4
  34    installed, then the DDE fallback for creating icons the Windows 3.1
  35    progman way will be used instead, but that is prone to lockups
  36    caused by other applications not servicing their message queues.  */
  37 #include <stdlib.h>
  38 #include <stdio.h>
  39 #include <malloc.h>
  40
  41 /* MinGW64 defines _W64 and barfs if _WIN32_IE is defined to anything
  42    below 0x500.  */
  43 #ifndef _W64
  44 #define _WIN32_IE 0x400
  45 #endif
  46 /* Request C Object macros for COM interfaces.  */
  47 #define COBJMACROS 1
  48
  49 #include <windows.h>
  50 #include <shlobj.h>
  51 #include <ddeml.h>
  52
  53 HDDEDATA CALLBACK
  54 DdeCallback (UINT uType, UINT uFmt, HCONV hconv,
  55              HSZ hsz1, HSZ hsz2, HDDEDATA hdata,
  56              DWORD dwData1, DWORD dwData2)
  57 {
  58   return ((HDDEDATA) NULL);
  59 }
  60
  61 #define DdeCommand(str)         \
  62         DdeClientTransaction (str, strlen (str)+1, conversation, (HSZ)NULL, \
  63                               CF_TEXT, XTYP_EXECUTE, 30000, NULL)
  64
  65 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
  66 #define REG_GTK "SOFTWARE\\GTK\\2.0"
  67 #define REG_APP_PATH \
  68   "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\App Paths\\emacs.exe"
  69 #define REG_RUNEMACS_PATH \
  70   "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\App Paths\\runemacs.exe"
  71
  72 static struct entry
  73 {
  74   const char *name;
  75   const char *value;
  76 }
  77 env_vars[] =
  78 {
  79   {"emacs_dir", NULL},
  80   {"EMACSLOADPATH", "%emacs_dir%/site-lisp;%emacs_dir%/../site-lisp;%emacs_dir%/lisp;%emacs_dir%/leim"},
  81   {"SHELL", "%emacs_dir%/bin/cmdproxy.exe"},
  82   {"EMACSDATA", "%emacs_dir%/etc"},
  83   {"EMACSPATH", "%emacs_dir%/bin"},
  84   /* We no longer set INFOPATH because Info-default-directory-list
  85      is then ignored.  */
  86   /*  {"INFOPATH", "%emacs_dir%/info"},  */
  87   {"EMACSDOC", "%emacs_dir%/etc"},
  88   {"TERM", "cmd"}
  89 };
  90
  91 BOOL
  92 add_registry (const char *path)
  93 {
  94   HKEY hrootkey = NULL;
  95   int i;
  96   BOOL ok = TRUE;
  97   DWORD size;
  98
  99   /* Record the location of Emacs to the App Paths key if we have
 100      sufficient permissions to do so.  This helps Windows find emacs quickly
 101      if the user types emacs.exe in the "Run Program" dialog without having
 102      emacs on their path.  Some applications also use the same registry key
 103      to discover the installation directory for programs they are looking for.
 104      Multiple installations cannot be handled by this method, but it does not
 105      affect the general operation of other installations of Emacs, and we
 106      are blindly overwriting the Start Menu entries already.
 107   */
 108   if (RegCreateKeyEx (HKEY_LOCAL_MACHINE, REG_APP_PATH, 0, "",
 109                       REG_OPTION_NON_VOLATILE, KEY_WRITE, NULL,
 110                       &hrootkey, NULL) == ERROR_SUCCESS)
 111     {
 112       int len;
 113       char *emacs_path;
 114       HKEY gtk_key = NULL;
 115
 116       len = strlen (path) + 15; /* \bin\emacs.exe + terminator.  */
 117       emacs_path = (char *) alloca (len);
 118       sprintf (emacs_path, "%s\\bin\\emacs.exe", path);
 119
 120       RegSetValueEx (hrootkey, NULL, 0, REG_EXPAND_SZ, emacs_path, len);
 121
 122       /* Look for a GTK installation. If found, add it to the library search
 123          path for Emacs so that the image libraries it provides are available
 124          to Emacs regardless of whether it is in the path or not.  */
 125       if (RegOpenKeyEx (HKEY_LOCAL_MACHINE, REG_GTK, REG_OPTION_NON_VOLATILE,
 126                         KEY_READ, &gtk_key) == ERROR_SUCCESS)
 127         {
 128           if (RegQueryValueEx (gtk_key, "DllPath", NULL, NULL,
 129                                NULL, &size) == ERROR_SUCCESS)
 130             {
 131               char *gtk_path = (char *) alloca (size);
 132               if (RegQueryValueEx (gtk_key, "DllPath", NULL, NULL,
 133                                    gtk_path, &size) == ERROR_SUCCESS)
 134                 {
 135                   /* Make sure the emacs bin directory continues to be searched
 136                      first by including it as well.  */
 137                   char *dll_paths;
 138                   HKEY runemacs_key = NULL;
 139                   len = strlen (path) + 5 + size;
 140                   dll_paths = (char *) alloca (size + strlen (path) + 1);
 141                   sprintf (dll_paths, "%s\\bin;%s", path, gtk_path);
 142                   RegSetValueEx (hrootkey, "Path", 0, REG_EXPAND_SZ,
 143                                  dll_paths, len);
 144
 145                   /* Set the same path for runemacs.exe, as the Explorer shell
 146                      looks this up, so the above does not take effect when
 147                      emacs.exe is spawned from runemacs.exe.  */
 148                   if (RegCreateKeyEx (HKEY_LOCAL_MACHINE, REG_RUNEMACS_PATH,
 149                                       0, "", REG_OPTION_NON_VOLATILE,
 150                                       KEY_WRITE, NULL, &runemacs_key, NULL)
 151                       == ERROR_SUCCESS)
 152                     {
 153                       RegSetValueEx (runemacs_key, "Path", 0, REG_EXPAND_SZ,
 154                                      dll_paths, len);
 155
 156                       RegCloseKey (runemacs_key);
 157                     }
 158                 }
 159             }
 160           RegCloseKey (gtk_key);
 161         }
 162       RegCloseKey (hrootkey);
 163     }
 164
 165   /* Previous versions relied on registry settings, but we do not need
 166      them any more.  If registry settings are installed from a previous
 167      version, replace them to ensure they are the current settings.
 168      Otherwise, do nothing.  */
 169
 170   /* Check both the current user and the local machine to see if we
 171      have any resources.  */
 172
 173   if (RegOpenKeyEx (HKEY_LOCAL_MACHINE, REG_ROOT,
 174                       REG_OPTION_NON_VOLATILE,
 175                       KEY_WRITE, &hrootkey) != ERROR_SUCCESS
 176       && RegOpenKeyEx (HKEY_CURRENT_USER, REG_ROOT,
 177                          REG_OPTION_NON_VOLATILE,
 178                          KEY_WRITE, &hrootkey) != ERROR_SUCCESS)
 179     {
 180       return FALSE;
 181     }
 182
 183   for (i = 0; i < (sizeof (env_vars) / sizeof (env_vars[0])); i++)
 184     {
 185       const char * value = env_vars[i].value ? env_vars[i].value : path;
 186
 187       if (RegSetValueEx (hrootkey, env_vars[i].name,
 188                          0, REG_EXPAND_SZ,
 189                          value, lstrlen (value) + 1) != ERROR_SUCCESS)
 190         ok = FALSE;
 191     }
 192
 193   RegCloseKey (hrootkey);
 194
 195   return (ok);
 196 }
 197
 198 int
 199 main (int argc, char *argv[])
 200 {
 201   char start_folder[MAX_PATH + 1];
 202   int shortcuts_created = 0;
 203   int com_available = 1;
 204   char modname[MAX_PATH];
 205   const char *prog_name;
 206   const char *emacs_path;
 207   char *p;
 208   int quiet = 0;
 209   HRESULT result;
 210   IShellLinkA *shortcut;
 211
 212   /* If no args specified, use our location to set emacs_path.  */
 213
 214   if (argc > 1
 215       && (argv[1][0] == '/' || argv[1][0] == '-')
 216       && argv[1][1] == 'q')
 217     {
 218       quiet = 1;
 219       --argc;
 220       ++argv;
 221     }
 222
 223   if (argc > 1)
 224     emacs_path = argv[1];
 225   else
 226     {
 227       if (!GetModuleFileName (NULL, modname, MAX_PATH) ||
 228           (p = strrchr (modname, '\\')) == NULL)
 229         {
 230           fprintf (stderr, "fatal error");
 231           exit (1);
 232         }
 233       *p = 0;
 234
 235       /* Set emacs_path to emacs_dir if we are in "%emacs_dir%\bin".  */
 236       if ((p = strrchr (modname, '\\')) && stricmp (p, "\\bin") == 0)
 237         {
 238           *p = 0;
 239           emacs_path = modname;
 240         }
 241       else
 242         {
 243           fprintf (stderr, "usage: addpm emacs_path\n");
 244           exit (1);
 245         }
 246
 247       /* Tell user what we are going to do.  */
 248       if (!quiet)
 249         {
 250           int result;
 251
 252           char msg[ MAX_PATH ];
 253           sprintf (msg, "Install Emacs at %s?\n", emacs_path);
 254           result = MessageBox (NULL, msg, "Install Emacs",
 255                                MB_OKCANCEL | MB_ICONQUESTION);
 256           if (result != IDOK)
 257             {
 258               fprintf (stderr, "Install canceled\n");
 259               exit (1);
 260             }
 261         }
 262     }
 263
 264   add_registry (emacs_path);
 265   prog_name =  "runemacs.exe";
 266
 267   /* Try to install globally.  */
 268
 269   if (!SUCCEEDED (CoInitialize (NULL))
 270       || !SUCCEEDED (CoCreateInstance (&CLSID_ShellLink, NULL,
 271                                         CLSCTX_INPROC_SERVER, &IID_IShellLinkA,
 272                                         (void **) &shortcut)))
 273     {
 274       com_available = 0;
 275     }
 276
 277   if (com_available
 278       && SHGetSpecialFolderPath (NULL, start_folder, CSIDL_COMMON_PROGRAMS, 0))
 279     {
 280       if (strlen (start_folder) < (MAX_PATH - 20))
 281         {
 282           strcat (start_folder, "\\Gnu Emacs");
 283           if (CreateDirectory (start_folder, NULL)
 284               || GetLastError () == ERROR_ALREADY_EXISTS)
 285             {
 286               char full_emacs_path[MAX_PATH + 1];
 287               IPersistFile *lnk;
 288               strcat (start_folder, "\\Emacs.lnk");
 289               sprintf (full_emacs_path, "%s\\bin\\%s", emacs_path, prog_name);
 290               IShellLinkA_SetPath (shortcut, full_emacs_path);
 291               IShellLinkA_SetDescription (shortcut, "GNU Emacs");
 292               result = IShellLinkA_QueryInterface (shortcut, &IID_IPersistFile,
 293                                                    (void **) &lnk);
 294               if (SUCCEEDED (result))
 295                 {
 296                   wchar_t unicode_path[MAX_PATH];
 297                   MultiByteToWideChar (CP_ACP, 0, start_folder, -1,
 298                                        unicode_path, MAX_PATH);
 299                   if (SUCCEEDED (IPersistFile_Save (lnk, unicode_path, TRUE)))
 300                     shortcuts_created = 1;
 301                   IPersistFile_Release (lnk);
 302                 }
 303             }
 304         }
 305     }
 306
 307   if (!shortcuts_created && com_available
 308       && SHGetSpecialFolderPath (NULL, start_folder, CSIDL_PROGRAMS, 0))
 309     {
 310       /* Ensure there is enough room for "...\GNU Emacs\Emacs.lnk".  */
 311       if (strlen (start_folder) < (MAX_PATH - 20))
 312         {
 313           strcat (start_folder, "\\Gnu Emacs");
 314           if (CreateDirectory (start_folder, NULL)
 315               || GetLastError () == ERROR_ALREADY_EXISTS)
 316             {
 317               char full_emacs_path[MAX_PATH + 1];
 318               IPersistFile *lnk;
 319               strcat (start_folder, "\\Emacs.lnk");
 320               sprintf (full_emacs_path, "%s\\bin\\%s", emacs_path, prog_name);
 321               IShellLinkA_SetPath (shortcut, full_emacs_path);
 322               IShellLinkA_SetDescription (shortcut, "GNU Emacs");
 323               result = IShellLinkA_QueryInterface (shortcut, &IID_IPersistFile,
 324                                                    (void **) &lnk);
 325               if (SUCCEEDED (result))
 326                 {
 327                   wchar_t unicode_path[MAX_PATH];
 328                   MultiByteToWideChar (CP_ACP, 0, start_folder, -1,
 329                                        unicode_path, MAX_PATH);
 330                   if (SUCCEEDED (IPersistFile_Save (lnk, unicode_path, TRUE)))
 331                     shortcuts_created = 1;
 332                   IPersistFile_Release (lnk);
 333
 334                 }
 335             }
 336         }
 337     }
 338
 339   if (com_available)
 340     IShellLinkA_Release (shortcut);
 341
 342   /* Need to call uninitialize, even if ComInitialize failed.  */
 343   CoUninitialize ();
 344
 345   /* Fallback on old DDE method if the above failed.  */
 346   if (!shortcuts_created)
 347     {
 348       DWORD dde = 0;
 349       HCONV conversation;
 350       HSZ progman;
 351       char add_item[MAX_PATH*2 + 100];
 352
 353       DdeInitialize (&dde, (PFNCALLBACK) DdeCallback, APPCMD_CLIENTONLY, 0);
 354       progman = DdeCreateStringHandle (dde, "PROGMAN", CP_WINANSI);
 355       conversation = DdeConnect (dde, progman, progman, NULL);
 356       if (conversation)
 357         {
 358           DdeCommand ("[CreateGroup (\"Gnu Emacs\")]");
 359           DdeCommand ("[ReplaceItem (Emacs)]");
 360           sprintf (add_item, "[AddItem (\"%s\\bin\\%s\", Emacs)]",
 361                    emacs_path, prog_name);
 362           DdeCommand (add_item);
 363
 364           DdeDisconnect (conversation);
 365         }
 366
 367       DdeFreeStringHandle (dde, progman);
 368       DdeUninitialize (dde);
 369    }
 370
 371   return 0;
 372 }