code.delx.au - gnu-emacs/blob - nt/addpm.c

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