2 * Helper program to build unix menu entries
4 * Copyright 1997 Marcus Meissner
5 * Copyright 1998 Juergen Schmied
6 * Copyright 2003 Mike McCormack for CodeWeavers
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 * This program will read a Windows shortcut file using the IShellLink
24 * interface, then invoke wineshelllink with the appropriate arguments
25 * to create a KDE/Gnome menu entry for the shortcut.
27 * winemenubuilder [ -r ] <shortcut.lnk>
29 * If the -r parameter is passed, and the shortcut cannot be created,
30 * this program will add RunOnce entry to invoke itself at the next
31 * reboot. This covers the case when a ShortCut is created before the
32 * executable containing its icon.
37 #include "wine/port.h"
55 #include "bitmaps/wine.xpm"
56 #include "wine/debug.h"
58 WINE_DEFAULT_DEBUG_CHANNEL(menubuilder);
60 /* link file formats */
81 GRPICONDIRENTRY idEntries[1];
113 /* Icon extraction routines
115 * FIXME: should use PrivateExtractIcons and friends
116 * FIXME: should not use stdio
119 static BOOL SaveIconResAsXPM(const BITMAPINFO *pIcon, const char *szXPMFileName, const char *comment)
129 BOOL aColorUsed[256] = {0};
133 if (!((pIcon->bmiHeader.biBitCount == 4) || (pIcon->bmiHeader.biBitCount == 8)))
136 if (!(fXPMFile = fopen(szXPMFileName, "w")))
139 nHeight = pIcon->bmiHeader.biHeight / 2;
140 nXORWidthBytes = 4 * ((pIcon->bmiHeader.biWidth * pIcon->bmiHeader.biBitCount / 32)
141 + ((pIcon->bmiHeader.biWidth * pIcon->bmiHeader.biBitCount % 32) > 0));
142 nANDWidthBytes = 4 * ((pIcon->bmiHeader.biWidth / 32)
143 + ((pIcon->bmiHeader.biWidth % 32) > 0));
144 b8BitColors = pIcon->bmiHeader.biBitCount == 8;
145 nColors = pIcon->bmiHeader.biClrUsed ? pIcon->bmiHeader.biClrUsed
146 : 1 << pIcon->bmiHeader.biBitCount;
147 pXOR = (BYTE*) pIcon + sizeof (BITMAPINFOHEADER) + (nColors * sizeof (RGBQUAD));
148 pAND = pXOR + nHeight * nXORWidthBytes;
150 #define MASK(x,y) (pAND[(x) / 8 + (nHeight - (y) - 1) * nANDWidthBytes] & (1 << (7 - (x) % 8)))
151 #define COLOR(x,y) (b8BitColors ? pXOR[(x) + (nHeight - (y) - 1) * nXORWidthBytes] : (x) % 2 ? pXOR[(x) / 2 + (nHeight - (y) - 1) * nXORWidthBytes] & 0xF : (pXOR[(x) / 2 + (nHeight - (y) - 1) * nXORWidthBytes] & 0xF0) >> 4)
153 for (i = 0; i < nHeight; i++) {
154 for (j = 0; j < pIcon->bmiHeader.biWidth; j++) {
155 if (!aColorUsed[COLOR(j,i)] && !MASK(j,i))
157 aColorUsed[COLOR(j,i)] = TRUE;
163 if (fprintf(fXPMFile, "/* XPM */\n/* %s */\nstatic char *icon[] = {\n", comment) <= 0)
165 if (fprintf(fXPMFile, "\"%d %d %d %d\",\n",
166 (int) pIcon->bmiHeader.biWidth, nHeight, nColorsUsed + 1, 2) <=0)
169 for (i = 0; i < nColors; i++) {
171 if (fprintf(fXPMFile, "\"%.2X c #%.2X%.2X%.2X\",\n", i, pIcon->bmiColors[i].rgbRed,
172 pIcon->bmiColors[i].rgbGreen, pIcon->bmiColors[i].rgbBlue) <= 0)
175 if (fprintf(fXPMFile, "\" c None\"") <= 0)
178 for (i = 0; i < nHeight; i++)
180 if (fprintf(fXPMFile, ",\n\"") <= 0)
182 for (j = 0; j < pIcon->bmiHeader.biWidth; j++)
186 if (fprintf(fXPMFile, " ") <= 0)
190 if (fprintf(fXPMFile, "%.2X", COLOR(j,i)) <= 0)
193 if (fprintf(fXPMFile, "\"") <= 0)
196 if (fprintf(fXPMFile, "};\n") <= 0)
207 unlink( szXPMFileName );
211 static BOOL CALLBACK EnumResNameProc(HMODULE hModule, LPCSTR lpszType, LPSTR lpszName, LONG lParam)
213 ENUMRESSTRUCT *sEnumRes = (ENUMRESSTRUCT *) lParam;
215 if (!sEnumRes->nIndex--)
217 *sEnumRes->pResInfo = FindResourceA(hModule, lpszName, (LPSTR)RT_GROUP_ICON);
224 static BOOL ExtractFromEXEDLL(const char *szFileName, int nIndex, const char *szXPMFileName)
230 GRPICONDIR *pIconDir;
232 ENUMRESSTRUCT sEnumRes;
237 if (!(hModule = LoadLibraryExA(szFileName, 0, LOAD_LIBRARY_AS_DATAFILE)))
239 WINE_ERR("LoadLibraryExA (%s) failed, error %ld\n", szFileName, GetLastError());
245 hResInfo = FindResourceA(hModule, MAKEINTRESOURCEA(-nIndex), (LPSTR)RT_GROUP_ICON);
246 WINE_ERR("FindResourceA (%s) called, return %p, error %ld\n", szFileName, hResInfo, GetLastError());
251 sEnumRes.pResInfo = &hResInfo;
252 sEnumRes.nIndex = nIndex;
253 EnumResourceNamesA(hModule, (LPSTR)RT_GROUP_ICON, &EnumResNameProc, (LONG) &sEnumRes);
258 WINE_ERR("ExtractFromEXEDLL failed, error %ld\n", GetLastError());
262 if (!(hResData = LoadResource(hModule, hResInfo)))
264 WINE_ERR("LoadResource failed, error %ld\n", GetLastError());
267 if (!(pIconDir = LockResource(hResData)))
269 WINE_ERR("LockResource failed, error %ld\n", GetLastError());
273 for (i = 0; i < pIconDir->idCount; i++)
274 if ((pIconDir->idEntries[i].wBitCount >= nMaxBits) && (pIconDir->idEntries[i].wBitCount <= 8))
276 if (pIconDir->idEntries[i].wBitCount > nMaxBits)
278 nMaxBits = pIconDir->idEntries[i].wBitCount;
281 if ((pIconDir->idEntries[i].bHeight * pIconDir->idEntries[i].bWidth) > nMax)
283 lpName = MAKEINTRESOURCEA(pIconDir->idEntries[i].nID);
284 nMax = pIconDir->idEntries[i].bHeight * pIconDir->idEntries[i].bWidth;
288 FreeResource(hResData);
290 if (!(hResInfo = FindResourceA(hModule, lpName, (LPSTR)RT_ICON)))
292 WINE_ERR("Second FindResourceA failed, error %ld\n", GetLastError());
295 if (!(hResData = LoadResource(hModule, hResInfo)))
297 WINE_ERR("Second LoadResource failed, error %ld\n", GetLastError());
300 if (!(pIcon = LockResource(hResData)))
302 WINE_ERR("Second LockResource failed, error %ld\n", GetLastError());
306 if(!SaveIconResAsXPM(pIcon, szXPMFileName, szFileName))
308 WINE_ERR("Failed saving icon as XPM, error %ld\n", GetLastError());
312 FreeResource(hResData);
313 FreeLibrary(hModule);
318 FreeResource(hResData);
320 FreeLibrary(hModule);
325 /* get the Unix file name for a given path, allocating the string */
326 inline static char *get_unix_file_name( const char *dos )
328 char buffer[MAX_PATH], *ret;
330 if (!wine_get_unix_file_name( dos, buffer, sizeof(buffer) )) return NULL;
331 ret = HeapAlloc( GetProcessHeap(), 0, lstrlenA( buffer ) + 1 );
332 lstrcpyA( ret, buffer );
336 static int ExtractFromICO(const char *szFileName, const char *szXPMFileName)
340 ICONDIRENTRY *pIconDirEntry;
347 filename = get_unix_file_name(szFileName);
348 if (!(fICOFile = fopen(filename, "r")))
351 if (fread(&iconDir, sizeof (ICONDIR), 1, fICOFile) != 1)
353 if ((iconDir.idReserved != 0) || (iconDir.idType != 1))
356 if ((pIconDirEntry = malloc(iconDir.idCount * sizeof (ICONDIRENTRY))) == NULL)
358 if (fread(pIconDirEntry, sizeof (ICONDIRENTRY), iconDir.idCount, fICOFile) != iconDir.idCount)
361 for (i = 0; i < iconDir.idCount; i++)
362 if ((pIconDirEntry[i].bHeight * pIconDirEntry[i].bWidth) > nMax)
365 nMax = pIconDirEntry[i].bHeight * pIconDirEntry[i].bWidth;
367 if ((pIcon = malloc(pIconDirEntry[nIndex].dwBytesInRes)) == NULL)
369 if (fseek(fICOFile, pIconDirEntry[nIndex].dwImageOffset, SEEK_SET))
371 if (fread(pIcon, pIconDirEntry[nIndex].dwBytesInRes, 1, fICOFile) != 1)
374 if(!SaveIconResAsXPM(pIcon, szXPMFileName, szFileName))
390 HeapFree(GetProcessHeap(), 0, filename);
394 static BOOL create_default_icon( const char *filename, const char* comment )
399 if (!(fXPM = fopen(filename, "w"))) return FALSE;
400 if (fprintf(fXPM, "/* XPM */\n/* %s */\nstatic char * icon[] = {", comment) <= 0)
402 for (i = 0; i < sizeof(wine_xpm)/sizeof(wine_xpm[0]); i++) {
403 if (fprintf( fXPM, "\n\"%s\",", wine_xpm[i]) <= 0)
406 if (fprintf( fXPM, "};\n" ) <=0)
417 static unsigned short crc16(const char* string)
419 unsigned short crc = 0;
422 for (i = 0; string[i] != 0; i++)
425 for (j = 0; j < 8; c >>= 1, j++)
427 xor_poly = (c ^ crc) & 1;
436 /* extract an icon from an exe or icon file; helper for IPersistFile_fnSave */
437 static char *extract_icon( const char *path, int index)
441 char *iconsdir, *ico_path, *ico_name, *xpm_path;
445 /* Where should we save the icon? */
446 WINE_TRACE("path=[%s] index=%d\n",path,index);
447 iconsdir=NULL; /* Default is no icon */
448 if (!RegOpenKeyA( HKEY_LOCAL_MACHINE, "Software\\Wine\\Wine\\Config\\Wine", &hkey ))
451 if (RegQueryValueExA(hkey, "IconsDir", 0, NULL, NULL, &size)==0) {
452 iconsdir = HeapAlloc(GetProcessHeap(), 0, size);
453 RegQueryValueExA(hkey, "IconsDir", 0, NULL, iconsdir, &size);
455 s=get_unix_file_name(iconsdir);
457 HeapFree(GetProcessHeap(), 0, iconsdir);
463 if (iconsdir==NULL || *iconsdir=='\0')
466 HeapFree(GetProcessHeap(), 0, iconsdir);
467 return NULL; /* No icon created */
470 /* If icon path begins with a '*' then this is a deferred call */
477 /* Determine the icon base name */
478 ico_path=HeapAlloc(GetProcessHeap(), 0, lstrlenA(path)+1);
479 strcpy(ico_path, path);
482 if (*s=='/' || *s=='\\') {
490 if (*ico_name=='\\') *ico_name++='\0';
491 s=strrchr(ico_name,'.');
494 /* Compute the source-path hash */
497 /* Try to treat the source file as an exe */
498 xpm_path=HeapAlloc(GetProcessHeap(), 0, strlen(iconsdir)+1+4+1+strlen(ico_name)+1+12+1+3);
499 sprintf(xpm_path,"%s/%04x_%s.%d.xpm",iconsdir,crc,ico_name,index);
500 if (ExtractFromEXEDLL( path, index, xpm_path ))
503 /* Must be something else, ignore the index in that case */
504 sprintf(xpm_path,"%s/%04x_%s.xpm",iconsdir,crc,ico_name);
505 if (ExtractFromICO( path, xpm_path))
508 if (create_default_icon( xpm_path, path ))
511 HeapFree( GetProcessHeap(), 0, xpm_path );
515 HeapFree( GetProcessHeap(), 0, ico_path );
519 static BOOL DeferToRunOnce(LPWSTR link)
523 const WCHAR szRunOnce[] = {
524 'S','o','f','t','w','a','r','e','\\',
525 'M','i','c','r','o','s','o','f','t','\\',
526 'W','i','n','d','o','w','s','\\',
527 'C','u','r','r','e','n','t','V','e','r','s','i','o','n','\\',
528 'R','u','n','O','n','c','e',0
530 const WCHAR szFormat[] = { '%','s',' ','"','%','s','"',0 };
532 WCHAR szExecutable[MAX_PATH];
534 WINE_TRACE( "Deferring icon creation to reboot.\n");
536 if( !GetModuleFileNameW( 0, szExecutable, MAX_PATH ) )
539 len = ( lstrlenW( link ) + lstrlenW( szExecutable ) + 4)*sizeof(WCHAR);
540 buffer = HeapAlloc( GetProcessHeap(), 0, len );
544 wsprintfW( buffer, szFormat, szExecutable, link );
546 r = RegCreateKeyExW(HKEY_LOCAL_MACHINE, szRunOnce, 0,
547 NULL, REG_OPTION_NON_VOLATILE, KEY_WRITE, NULL, &hkey, NULL);
548 if ( r == ERROR_SUCCESS )
550 r = RegSetValueExW(hkey, link, 0, REG_SZ,
551 (LPBYTE) buffer, (lstrlenW(buffer) + 1)*sizeof(WCHAR));
554 HeapFree(GetProcessHeap(), 0, buffer);
559 /* This escapes \ in filenames */
564 narg = HeapAlloc(GetProcessHeap(),0,2*strlen(arg)+2);
569 *x++='\\'; /* escape \ */
576 static int fork_and_wait( char *linker, char *link_name, char *path,
577 int desktop, char *args, char *icon_name,
578 char *workdir, char *description )
581 const char *argv[20];
583 WINE_TRACE( "linker app='%s' link='%s' mode=%s "
584 "path='%s' args='%s' icon='%s' workdir='%s' descr='%s'\n",
585 linker, link_name, desktop ? "desktop" : "menu",
586 path, args, icon_name, workdir, description );
588 argv[pos++] = linker ;
589 argv[pos++] = "--link";
590 argv[pos++] = link_name;
591 argv[pos++] = "--path";
593 argv[pos++] = desktop ? "--desktop" : "--menu";
594 if (args && strlen(args))
596 argv[pos++] = "--args";
601 argv[pos++] = "--icon";
602 argv[pos++] = icon_name;
604 if (workdir && strlen(workdir))
606 argv[pos++] = "--workdir";
607 argv[pos++] = workdir;
609 if (description && strlen(description))
611 argv[pos++] = "--descr";
612 argv[pos++] = description;
616 return spawnvp( _P_WAIT, linker, argv );
619 /* write the name of the ShellLinker into the buffer provided */
620 static BOOL GetLinkerName( LPSTR szLinker, DWORD max )
627 r = RegOpenKeyExA( HKEY_LOCAL_MACHINE,
628 "Software\\Wine\\Wine\\Config\\Wine",
629 0, KEY_ALL_ACCESS, &hkey );
632 r = RegQueryValueExA( hkey, "ShellLinker", 0, &type, szLinker, &max );
634 if( r || ( type != REG_SZ ) )
640 static char *cleanup_link( LPCWSTR link )
645 /* make link name a Unix name -
646 strip leading slashes & remove extension */
647 while ( (*link == '\\') || (*link == '/' ) )
649 len = WideCharToMultiByte( CP_ACP, 0, link, -1, NULL, 0, NULL, NULL);
650 link_name = HeapAlloc( GetProcessHeap(), 0, len*sizeof (WCHAR) );
653 len = WideCharToMultiByte( CP_ACP, 0, link, -1, link_name, len, NULL, NULL);
654 for (p = link_name; *p; p++)
657 p = strrchr( link_name, '.' );
663 /***********************************************************************
667 * returns TRUE if successful
668 * *loc will contain CS_DESKTOPDIRECTORY, CS_STARTMENU, CS_STARTUP
670 static BOOL GetLinkLocation( LPCWSTR linkfile, DWORD *ofs, DWORD *loc )
672 WCHAR ch, filename[MAX_PATH], buffer[MAX_PATH];
674 const DWORD locations[] = {
675 CSIDL_STARTUP, CSIDL_DESKTOPDIRECTORY, CSIDL_STARTMENU };
677 if( !GetFullPathNameW( linkfile, MAX_PATH, filename, NULL ))
680 for( i=0; i<sizeof(locations)/sizeof(locations[0]); i++ )
682 if (!SHGetSpecialFolderPathW( 0, buffer, locations[i], FALSE ))
685 len = lstrlenW(buffer);
686 if( len >= MAX_PATH )
689 /* do a lstrcmpinW */
692 r = lstrcmpiW( filename, buffer );
698 /* return the remainder of the string and link type */
707 static BOOL InvokeShellLinker( IShellLinkA *sl, LPCWSTR link )
709 char *link_name, *p, *icon_name = NULL, *work_dir = NULL;
710 char *escaped_path = NULL, *escaped_args = NULL;
711 CHAR szDescription[MAX_PATH], szPath[MAX_PATH], szWorkDir[MAX_PATH];
712 CHAR szArgs[MAX_PATH], szIconPath[MAX_PATH], szLinker[MAX_PATH];
714 DWORD ofs=0, csidl= -1;
718 WINE_ERR("Link name is null\n");
722 if( !GetLinkerName( szLinker, MAX_PATH ) )
724 WINE_ERR("Can't find the name of the linker script\n");
728 if( !GetLinkLocation( link, &ofs, &csidl ) )
730 WINE_WARN("Unknown link location (%08lx). Ignoring\n", csidl);
733 if( (csidl != CSIDL_DESKTOPDIRECTORY) && (csidl != CSIDL_STARTMENU) )
735 WINE_WARN("Not under desktop or start menu. Ignoring.\n");
740 IShellLinkA_GetWorkingDirectory( sl, szWorkDir, sizeof(szWorkDir));
741 WINE_TRACE("workdir : %s\n", szWorkDir);
743 szDescription[0] = 0;
744 IShellLinkA_GetDescription( sl, szDescription, sizeof(szDescription));
745 WINE_TRACE("description: %s\n", szDescription);
748 IShellLinkA_GetPath( sl, szPath, sizeof(szPath), NULL, SLGP_RAWPATH );
749 WINE_TRACE("path : %s\n", szPath);
752 IShellLinkA_GetArguments( sl, szArgs, sizeof(szArgs) );
753 WINE_TRACE("args : %s\n", szArgs);
756 IShellLinkA_GetIconLocation( sl, szIconPath,
757 sizeof(szIconPath), &iIconId );
758 WINE_TRACE("icon file : %s\n", szIconPath );
762 LPITEMIDLIST pidl = NULL;
763 IShellLinkA_GetIDList( sl, &pidl );
764 if( pidl && SHGetPathFromIDListA( pidl, szPath ) );
765 WINE_TRACE("pidl path : %s\n", szPath );
768 /* extract the icon */
770 icon_name = extract_icon( szIconPath , iIconId );
772 icon_name = extract_icon( szPath, iIconId );
774 /* fail - try once again at reboot time */
777 WINE_ERR("failed to extract icon.\n");
784 /* check for .exe extension */
785 if (!(p = strrchr( szPath, '.' ))) return FALSE;
786 if (strchr( p, '\\' ) || strchr( p, '/' )) return FALSE;
787 if (strcasecmp( p, ".exe" )) return FALSE;
789 /* convert app working dir */
791 work_dir = get_unix_file_name( szWorkDir );
795 /* if there's no path... try run the link itself */
796 WideCharToMultiByte( CP_ACP, 0, link, -1, szArgs, MAX_PATH, NULL, NULL );
797 strcpy(szPath, "C:\\Windows\\System\\start.exe");
800 link_name = cleanup_link( &link[ofs] );
803 WINE_ERR("Couldn't clean up link name\n");
807 /* escape the path and parameters */
808 escaped_path = escape(szPath);
810 escaped_args = escape(szArgs);
812 r = fork_and_wait(szLinker, link_name, escaped_path,
813 (csidl == CSIDL_DESKTOPDIRECTORY), escaped_args, icon_name,
814 work_dir ? work_dir : "", szDescription );
816 HeapFree( GetProcessHeap(), 0, icon_name );
817 HeapFree( GetProcessHeap(), 0, work_dir );
818 HeapFree( GetProcessHeap(), 0, link_name );
820 HeapFree( GetProcessHeap(), 0, escaped_args );
822 HeapFree( GetProcessHeap(), 0, escaped_path );
826 WINE_ERR("failed to fork and exec %s\n", szLinker );
834 static BOOL Process_Link( LPWSTR linkname, BOOL bAgain )
839 WCHAR fullname[MAX_PATH];
843 WINE_ERR("link name missing\n");
847 if( !GetFullPathNameW( linkname, MAX_PATH, fullname, NULL ))
849 WINE_ERR("couldn't get full path of link file\n");
853 r = CoInitialize( NULL );
857 r = CoCreateInstance( &CLSID_ShellLink, NULL, CLSCTX_INPROC_SERVER,
858 &IID_IShellLink, (LPVOID *) &sl );
861 WINE_ERR("No IID_IShellLink\n");
865 r = IShellLinkA_QueryInterface( sl, &IID_IPersistFile, (LPVOID*) &pf );
868 WINE_ERR("No IID_IPersistFile\n");
872 r = IPersistFile_Load( pf, fullname, STGM_READ );
875 /* If we something fails (eg. Couldn't extract icon)
876 * defer this menu entry to reboot via runonce
878 if( ! InvokeShellLinker( sl, fullname ) && bAgain )
879 DeferToRunOnce( fullname );
881 WINE_TRACE("Success.\n");
884 IPersistFile_Release( pf );
885 IShellLinkA_Release( sl );
893 static CHAR *next_token( LPSTR *p )
895 LPSTR token = NULL, t = *p;
908 /* unquote the token */
910 t = strchr( token, '"' );
919 t = strchr( token, ' ' );
929 /***********************************************************************
933 int PASCAL WinMain (HINSTANCE hInstance, HINSTANCE prev, LPSTR cmdline, int show)
935 LPSTR token = NULL, p;
937 HANDLE hsem = CreateSemaphoreA( NULL, 1, 1, "winemenubuilder_semaphore");
940 /* running multiple instances of wineshelllink
941 at the same time may be dangerous */
942 if( WAIT_OBJECT_0 != WaitForSingleObject( hsem, INFINITE ) )
945 for( p = cmdline; p && *p; )
947 token = next_token( &p );
950 if( !lstrcmpA( token, "-r" ) )
952 else if( token[0] == '-' )
954 WINE_ERR( "unknown option %s\n",token);
958 WCHAR link[MAX_PATH];
960 MultiByteToWideChar( CP_ACP, 0, token, -1, link, sizeof(link) );
961 if( !Process_Link( link, bAgain ) )
963 WINE_ERR( "failed to build menu item for %s\n",token);
970 ReleaseSemaphore( hsem, 1, NULL );