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