diff --git a/README.md b/README.md index 6d159f9..5f71eb8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ ## Homerun: killswitch for browsers Not everyone of us gets the privacy they deserve. Because of that, people who live under rather problematic conditions (e.g a person living in a toxic household) can get in great danger if someone finds them looking at something "they're not supposed to". -**Homerun** helps the user to avoid such situations by providing them with a killswitch for all open browser windows. Whenever the user feels endangered, instead of manically clicking "Close" on every browser window, they can just press **Ctrl-Home**. This will close all browser windows, whether they are active or not. +**Homerun** helps the user to avoid such situations by providing them with a killswitch for all open browser windows. Whenever the user feels endangered, instead of manically clicking "Close" on every browser window, they can just press **Ctrl-Home**. This will "get you home", closing all browser windows whether they are active or not. You can press **Win-Home** to open the program's settings. There, you can select which browsers get closed and which don't, and whether the program displays the "Homerun is up" message whenever it starts. diff --git a/installer/0.1/install_homerun.exe b/installer/0.1/install_homerun.exe new file mode 100644 index 0000000..b84c9c4 Binary files /dev/null and b/installer/0.1/install_homerun.exe differ diff --git a/src/0.1/homerun/homerun.ahk b/src/0.1/homerun/homerun.ahk new file mode 100644 index 0000000..86db488 --- /dev/null +++ b/src/0.1/homerun/homerun.ahk @@ -0,0 +1,107 @@ +#Persistent +; we only want one instance running at a time, +; things could get rather tangled up if more +; than one instance ran simultaneously +#SingleInstance force + +; read settings from homerun.ini file +IniRead, CloseEdge, homerun.ini, Homerun Settings, CloseEdge, 1 +IniRead, CloseChrome, homerun.ini, Homerun Settings, CloseChrome, 1 +IniRead, CloseFirefox, homerun.ini, Homerun Settings, CloseFirefox, 1 +IniRead, CloseOpera, homerun.ini, Homerun Settings, CloseOpera, 1 +IniRead, ShowSplash, homerun.ini, Homerun Settings, ShowSplash, 1 + +; tray icon and menu settings +Menu, Tray, Icon, homerun.exe, 1 +Menu, Tray, Tip, Homerun +Menu, Tray, NoStandard +Menu, Tray, Add, Settings, Settings +Menu, Tray, Add, Quit, Quit + +; create the gui and its elements +Gui, settings:New, -Resize -MaximizeBox -MinimizeBox +Gui, settings:Default +Gui, settings:Font, s8, Segoe UI +Gui, settings:Add, GroupBox, x2 y9 w170 h180, When Ctrl-Home is pressed: +Gui, settings:Add, CheckBox, x12 y29 w150 h30 vCloseEdge, Close Edge (msedge.exe) +Gui, settings:Add, CheckBox, x12 y69 w150 h30 vCloseChrome, Close Chrome (chrome.exe) +Gui, settings:Add, CheckBox, x12 y109 w150 h30 vCloseFirefox, Close Firefox (firefox.exe) +Gui, settings:Add, CheckBox, x12 y149 w150 h30 vCloseOpera, Close Opera (opera.exe) +Gui, settings:Add, CheckBox, x202 y29 w150 h30 vShowSplash, Show "Homerun is up" message on startup + +; make the checkboxes reflect the settings in homerun.ini +GuiControl,, CloseEdge, %CloseEdge% +GuiControl,, CloseChrome, %CloseChrome% +GuiControl,, CloseFirefox, %CloseFirefox% +GuiControl,, CloseOpera, %CloseOpera% +GuiControl,, ShowSplash, %ShowSplash% + +; more gui elements +Gui, settings:Add, Button, x72 y199 w90 h30 +ToolTip, OK +Gui, settings:Add, Button, x202 y199 w90 h30 , Cancel + +; append values from homerun.ini to program variables +CloseEdge=%CloseEdge% +CloseChrome=%CloseChrome% +CloseFirefox=%CloseFirefox% +CloseOpera=%CloseOpera% +ShowSplash=%ShowSplash% + +; program settings +if CloseEdge = 1 + GroupAdd, browse, ahk_exe msedge.exe + +if CloseChrome = 1 + GroupAdd, browse, ahk_exe chrome.exe + +if CloseFirefox = 1 + GroupAdd, browse, ahk_exe firefox.exe + +if CloseOpera = 1 + GroupAdd, browse, ahk_exe opera.exe + +if ShowSplash = 1 + MsgBox, 64, Homerun is up, Press Ctrl-Home to go home +Return + +; gui button settings +; cancel doesn't save any setting, ok/close +; saves the settings to memory, deletes the old +; homerun.ini file and writes the new values +; to a new version of homerun.ini +settingsButtonCancel: +Gui, settings:Cancel +Return + +settingsGuiClose: +settingsButtonOK: +Gui, settings:Submit + +if FileExist("homerun.ini") + FileDelete, homerun.ini + +IniWrite, %CloseEdge%, homerun.ini, Homerun Settings, CloseEdge +IniWrite, %CloseChrome%, homerun.ini, Homerun Settings, CloseChrome +IniWrite, %CloseFirefox%, homerun.ini, Homerun Settings, CloseFirefox +IniWrite, %CloseOpera%, homerun.ini, Homerun Settings, CloseOpera +IniWrite, %ShowSplash%, homerun.ini, Homerun Settings, ShowSplash +Return + +; tray menu elements +Quit: +ExitApp +Return + +Settings: +#Home:: +Gui, settings:Show, Center h243 w368, Homerun Settings +Return + +; when ctrl-home is pressed, this checks if there +; are any windows in the "browse" group and then +; closes all of them + +^Home:: +#if WinExist("ahk_group browse") + GroupClose, browse, A +Return \ No newline at end of file diff --git a/src/0.1/homerun/homerun.ico b/src/0.1/homerun/homerun.ico new file mode 100644 index 0000000..63261cf Binary files /dev/null and b/src/0.1/homerun/homerun.ico differ diff --git a/src/0.1/installer/LICENSE b/src/0.1/installer/LICENSE new file mode 100644 index 0000000..6abf580 --- /dev/null +++ b/src/0.1/installer/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/src/0.1/installer/header.bmp b/src/0.1/installer/header.bmp new file mode 100644 index 0000000..d7ea67c Binary files /dev/null and b/src/0.1/installer/header.bmp differ diff --git a/src/0.1/installer/homerunmui.nsi b/src/0.1/installer/homerunmui.nsi new file mode 100644 index 0000000..dc0ee54 --- /dev/null +++ b/src/0.1/installer/homerunmui.nsi @@ -0,0 +1,152 @@ +;Include Modern UI + + !include "MUI2.nsh" + !include "nsProcess.nsh" +;-------------------------------- +;General + + ;Name and file + Name "Homerun" + OutFile "install_homerun.exe" + Unicode True + + ;Default installation folder + InstallDir "$APPDATA\Homerun" + + ;Get installation folder from registry if available + InstallDirRegKey HKCU "Software\Homerun" "" + + ;Request application privileges for Windows Vista + RequestExecutionLevel admin + +;-------------------------------- +;Interface Settings + + !define MUI_ABORTWARNING + !define MUI_ICON "${NSISDIR}\Contrib\Graphics\Icons\classic-install.ico" + !define MUI_UNICON "${NSISDIR}\Contrib\Graphics\Icons\classic-uninstall.ico" + !define MUI_HEADERIMAGE + !define MUI_HEADERIMAGE_BITMAP "header.bmp" + !define MUI_HEADERIMAGE_BITMAP_NOSTRETCH + !define MUI_HEADERIMAGE_UNBITMAP "header.bmp" + !define MUI_HEADERIMAGE_UNBITMAP_NOSTRETCH + !define MUI_WELCOMEFINISHPAGE_BITMAP "wizard.bmp" + !define MUI_UNWELCOMEFINISHPAGE_BITMAP "wizard.bmp" +;-------------------------------- +;Pages + + !insertmacro MUI_PAGE_WELCOME + !insertmacro MUI_PAGE_LICENSE "LICENSE" + !insertmacro MUI_PAGE_COMPONENTS + !insertmacro MUI_PAGE_DIRECTORY + !insertmacro MUI_PAGE_INSTFILES + !define MUI_FINISHPAGE_RUN "$INSTDIR\homerun.exe" + !define MUI_FINISHPAGE_NOAUTOCLOSE + !define MUI_UNFINISHPAGE_NOAUTOCLOSE + !insertmacro MUI_PAGE_FINISH + + !insertmacro MUI_UNPAGE_WELCOME + !insertmacro MUI_UNPAGE_CONFIRM + !insertmacro MUI_UNPAGE_INSTFILES + !insertmacro MUI_UNPAGE_FINISH +;-------------------------------- +;Languages + + !insertmacro MUI_LANGUAGE "English" + +;-------------------------------- +;Installer Sections + +; The stuff to install +Section "Homerun (required)" SecHomerun + + SectionIn RO + + ; Set output path to the installation directory. + SetOutPath $INSTDIR + + ; Put files there + File "homerun.exe" + File "homerun.ini" + + ; Write the installation path into the registry + WriteRegStr HKLM SOFTWARE\Homerun "Install_Dir" "$INSTDIR" + + ; Write the uninstall keys for Windows + WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\Homerun" "DisplayName" "Homerun" + WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\Homerun" "UninstallString" '"$INSTDIR\uninstall.exe"' + WriteRegDWORD HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\Homerun" "NoModify" 1 + WriteRegDWORD HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\Homerun" "NoRepair" 1 + WriteUninstaller "$INSTDIR\uninstall.exe" + +SectionEnd + +; Optional section (can be disabled by the user) +Section "Start Menu Shortcuts" SecStartmenu + + CreateDirectory "$SMPROGRAMS\Homerun" + CreateShortcut "$SMPROGRAMS\Homerun\Uninstall.lnk" "$INSTDIR\uninstall.exe" "" "$INSTDIR\uninstall.exe" 0 + CreateShortcut "$SMPROGRAMS\Homerun\Homerun.lnk" "$INSTDIR\homerun.exe" "" "$INSTDIR\homerun.exe" 0 + +SectionEnd + +Section "Start Homerun on startup" SecStartup + + WriteRegStr HKLM "SOFTWARE\Microsoft\Windows\CurrentVersion\Run" "Homerun" "$INSTDIR\homerun.exe" + +SectionEnd + +;-------------------------------- +;Descriptions + + ;Language strings + LangString DESC_SecHomerun ${LANG_ENGLISH} "Installs Homerun." + LangString DESC_SecStartmenu ${LANG_ENGLISH} "Creates start menu shortcuts for Homerun." + LangString DESC_SecStartup ${LANG_ENGLISH} "Starts Homerun on startup." + ;Assign language strings to sections + !insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN + !insertmacro MUI_DESCRIPTION_TEXT ${SecHomerun} $(DESC_SecHomerun) + !insertmacro MUI_DESCRIPTION_TEXT ${SecStartmenu} $(DESC_SecStartmenu) + !insertmacro MUI_DESCRIPTION_TEXT ${SecStartup} $(DESC_SecStartup) + !insertmacro MUI_FUNCTION_DESCRIPTION_END + + Function .onInstSuccess + MessageBox MB_OK "Homerun is now installed and running. You can press Ctrl-Home to go home or Win-Home to open the settings." + FunctionEnd + +;-------------------------------- +;Uninstaller Section + +Section "Uninstall" + + ;Check if process is running and close it + ${nsProcess::FindProcess} "homerun.exe" $R0 + + ${If} $R0 == 0 + DetailPrint "Homerun is running. Closing it down" + ${nsProcess::CloseProcess} "homerun.exe" $R0 + DetailPrint "Waiting for Homerun to close" + Sleep 2000 + ${Else} + DetailPrint "Homerun was not found to be running" + ${EndIf} + +${nsProcess::Unload} + + ; Remove registry keys + DeleteRegKey HKLM "SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\Homerun" + DeleteRegKey HKLM "SOFTWARE\Homerun" + DeleteRegValue HKLM "SOFTWARE\Microsoft\Windows\CurrentVersion\Run" "Homerun" + ; Remove files and uninstaller + Delete $INSTDIR\homerun.exe + Delete $INSTDIR\homerun.ini + Delete $INSTDIR\uninstall.exe + + ; Remove shortcuts, if any + Delete "$SMPROGRAMS\Homerun\*.*" + + ; Remove directories used + RMDir "$SMPROGRAMS\Homerun" + RMDir "$INSTDIR" + +SectionEnd diff --git a/src/0.1/installer/wizard.bmp b/src/0.1/installer/wizard.bmp new file mode 100644 index 0000000..9a85e8a Binary files /dev/null and b/src/0.1/installer/wizard.bmp differ