FcnLib.ahk

#SingleInstance Force

#include thirdParty/Functions.ahk
#include thirdParty/CmdRet.ahk
#include thirdParty/Cycle.ahk
#include thirdParty/Format4Csv.ahk ;haven't used this yet, but I should
#include FcnLib-Rewrites.ahk
#include FcnLib-IniStats.ahk
#include FcnLib-GetUrlBar.ahk
#include FcnLib-Nightly.ahk ;this was mainly added for FastNotification()
;#include thirdParty\Notify.ahk ;this causes windows to be open forever

;Takes a screenshot and saves it to the specified path
;Useful for debugging macros afterward
;Includes an optional text parameter that will allow you to
;begin the filename with a relevant text description, and
;end it with a timestamp
;not implemented: adjust image quality, change image format
;PARAMETERS:
;   descriptiveText - prepended onto the front of the filename
;   directoryPath   - a path, "dropbox" or "local"
;   options         - "activeWindow"
;FIXME screenshot capability is broken
#include thirdParty/ScreenCapture.ahk
SaveScreenshot(descriptiveText="", directoryPath="dropbox", options="")
{
   ;TODO LowRes option
   ;TODO HighRes option
   captureArea=0
   if InStr(options, "activeWindow")
      captureArea=1

   if (directoryPath="") ;default
      directoryPath=dropbox
   if (directoryPath="dropbox")
      directoryPath=C:\Dropbox\AHKs\gitExempt\screenshots\%A_ComputerName%
   else if (directoryPath="local")
      directoryPath=C:\DataExchange\PrintScreen

   FileCreateDir, %directoryPath%
   FormatTime FileNameText,, yyyyMMddHHmmss
   fullfilename = %directoryPath%\%descriptiveText%%FileNameText%.bmp
   CaptureScreen(captureArea,true,fullfilename)
   ;addToTrace(fullFilename)
}

SaveScreenshot2()
{
   timestamp := CurrentTime("hyphenated")
   filenameJpg=C:\Dropbox\AHKs\gitExempt\screenshots\%A_ComputerName%\%timestamp%.jpg
   jpegQuality := 60

   ;take a screenshot of the specified area
   pToken:=Gdip_Startup()
   pBitmap:=Gdip_BitmapFromScreen("0|0|" A_ScreenWidth "|" A_ScreenHeight)
   Gdip_SaveBitmapToFile(pBitmap, filenameJpg, jpegQuality)
   Gdip_Shutdown(pToken)
}

;Sleeps for a specified number of minutes
SleepMinutes(minutes)
{
   SleepSeconds(minutes*60)
}

;Sleeps for a specified number of seconds
SleepSeconds(seconds)
{
   Sleep 1000*seconds
}

;Determines whether or not we should show debug msgs
;TODO add a logging mode?
;not yet finished, just throwing around some ideas
;OptionalDebug(options="", millionParams="...really, lots of params, like 15..")
OptionalDebug(textOrOptions="Hello World!", text1="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text2="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text3="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text4="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text5="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text6="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text7="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text8="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text9="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text10="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text11="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text12="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text13="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text14="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text15="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ")
{
   global A_Debug
   global A_Log
   if ( InStr(options, "Debug") || A_Debug )
      debug(textOrOptions, text1, text2, text3, text4, text5, text6, text7, text8, text9, text10, text11, text12, text13, text14, text15)
   if ( InStr(options, "Log") || A_Log )
      delog(textOrOptions, text1, text2, text3, text4, text5, text6, text7, text8, text9, text10, text11, text12, text13, text14, text15)
}

CustomTitleMatchMode(options="")
{
   ;By default this uses RegEx and Fast (no hidden window text detected)
   if (InStr(options, "Start"))
      SetTitleMatchMode, 1
   else if (InStr(options, "Contain") || InStr(options, "Anywhere"))
      SetTitleMatchMode, 2
   else if (InStr(options, "Exact"))
      SetTitleMatchMode, 3
   else if (InStr(options, "RegEx"))
      SetTitleMatchMode, RegEx
   else if (InStr(options, "Default"))
   {
      SetTitleMatchMode, 2
      ;SetTitleMatchMode, Fast
   }
   else
      SetTitleMatchMode, RegEx

   ;FIXME haxor... wrong method (will cause side effects)
   ;SendMode, Event
}

ForceWinFocus(titleofwin, options="")
{
   returned:=false
   prevMode :=A_TitleMatchMode
   prevSpeed:=A_TitleMatchModeSpeed
   CustomTitleMatchMode(options)

   OptionalDebug(options, titleofwin)

   Loop
   {
      WinWait, %titleofwin%, , 1
      IfWinNotActive, %titleofwin%,
         WinActivate, %titleofwin%,
      WinWaitActive, %titleofwin%, , 1
      IfWinActive, %titleofwin%,
      {
         returned:=true
         break
      }
   }

   ;CustomTitleMatchMode("Default")
   SetTitleMatchMode, %prevMode%
   SetTitleMatchMode, %prevSpeed%

   return returned
}

;NOTE this is not the same because it checks if the window already exists first
;  rather than just waiting forever for the window
;TODO probably should merge these two methods (with an ifexist option)
;or we could have a timeout option that waits for the specified
;number of seconds and then just returns false
ForceWinFocusIfExist(titleofwin, options="")
{
   returned:=false
   prevMode :=A_TitleMatchMode
   prevSpeed:=A_TitleMatchModeSpeed
   CustomTitleMatchMode(options)

   OptionalDebug(options, titleofwin)

   IfWinExist, %titleofwin%,
   {
      WinWait, %titleofwin%,
      IfWinNotActive, %titleofwin%,
         WinActivate, %titleofwin%,
      WinWaitActive, %titleofwin%,
      returned:=true
   }

   ;CustomTitleMatchMode("Default")
   SetTitleMatchMode, %prevMode%
   SetTitleMatchMode, %prevSpeed%

   return returned
}

;TODO not sure if the return values here are good or if they suck!
;Closes the window if it exists, then returns true if it actually did exist in the first place
WinClose(titleofwin, options="")
{
   prevMode :=A_TitleMatchMode
   prevSpeed:=A_TitleMatchModeSpeed
   CustomTitleMatchMode(options)

   OptionalDebug(options, titleofwin)

   IfWinExist, %titleofwin%,
   {
      WinClose, %titleofwin%,
      returned:=true
   }

   ;CustomTitleMatchMode("Default")
   SetTitleMatchMode, %prevMode%
   SetTitleMatchMode, %prevSpeed%

   return returned
}
;TODO deprecate/rename this critter
CloseWin(titleofwin, options="")
{
   WinClose(titleofwin, options)
}

;TESTME
SendViaClipboard(text)
{
   Sleep 100

   ;Save previous clipboard item
   ClipSaved := ClipboardAll

   Sleep 100

   ;Put item on the clipboard
   Clipboard := text

   ;May need to wait for a while
   ClipWait, 1

   MaxTimeToWait:=CurrentTimePlus(1)
   while (!CurrentlyAfter(MaxTimeToWait))
   {
      if (text==Clipboard)
         break
      if (text==ClipboardAll)
         break
      Sleep 50
   }

   Sleep 100

   ;Paste
   Send, ^v

   Sleep 100

   ;Restore clipboard contents, clear memory for storage variable
   Clipboard := ClipSaved
   ClipSaved=

   Sleep 100
}

SimpleImageSearchWithDimensions(filename, xStart, yStart, width, height)
{
   ;TODO merge this mode into the others
   ;should probably have a usage that looks like:
   ;   SimpleImageSearch("file.bmp", "{CoordZone:\"0,0,10,20\"}")
   ;should use json to specify the coordzone to search

   if NOT FileExist(filename)
   {
      errord(A_ThisFunc, filename, "the aforementioned file does not exist")
      return false
   }

   ;WinGetPos, no, no, winWidth, winHeight, A
   ImageSearch, xvar, yvar, xStart, yStart, width, height, %filename%

   return NOT ErrorLevel
}

SimpleImageSearch(filename)
{
   if NOT FileExist(filename)
   {
      errord(A_ThisFunc, filename, "the aforementioned file does not exist")
      return false
   }

   WinGetPos, no, no, winWidth, winHeight, A
   ImageSearch, xvar, yvar, 0, 0, winWidth, winHeight, %filename%
   returned := ! ERRORLEVEL

   ;FOR DEBUGGING ONLY
   ;if returned
      ;AddToTrace("Saw image: " . filename)

   return returned
}

;If you see the image, move the mouse there
MouseMoveIfImageSearch(filename)
{
   if NOT FileExist(filename)
   {
      errord(A_ThisFunc, filename, "the aforementioned file does not exist")
      return false
   }

   WinGetPos, no, no, winWidth, winHeight, A
   ImageSearch, xvar, yvar, 0, 0, winWidth, winHeight, %filename%

   MouseMove, xvar, yvar

   return NOT ErrorLevel
}

;If you see the image, click it
ClickIfImageSearch(filename, options="left mouse")
{
   ;TODO make this look a little more like:
   ;if NOT VerifyFileExist(A_ThisFunc, filename)
      ;return false
   ;if ErrordIfFileNotExist(A_ThisFunc, filename)
      ;return false

   ;if NOT FileExist(filename)
   ;{
      ;errord(A_ThisFunc, filename, "the aforementioned file does not exist")
      ;return false
   ;}

   WinGetPos, no, no, winWidth, winHeight, A
   ImageSearch, xvar, yvar, 0, 0, winWidth, winHeight, %filename%

   if NOT ErrorLevel
      Click(xvar, yvar, options)

   return NOT ErrorLevel
}

;Wait until a certain image appears
WaitForImageSearch(filename, variation=0, timeToWait=60, sleepTime=20) ;TODO option to exit ahk if image was not found
{
   if NOT FileExist(filename)
   {
      errord(A_ThisFunc, filename, "the aforementioned file does not exist")
      return false
   }

   TimeToStop:=CurrentTimePlus(timeToWait)
   while (CurrentlyBefore(TimeToStop))
   {
      WinGetPos, no, no, winWidth, winHeight, A
      ImageSearch, no, no, 0, 0, winWidth, winHeight, *%variation% %filename%

      if NOT ErrorLevel
         return true

      Sleep, sleepTime
   }
   delog(A_ThisFunc, "the function was waiting for the image to appear, but timed out", filename, variation, timeToWait, sleepTime)

   return false
}

WFCIImageSearch(filename, options="left mouse")
{
   WaitForImageSearch(filename)
   ClickIfImageSearch(filename, options)
}

;FIXME I don't like the boolean logic here... just doesn't seem readable
ErrordIfFileNotExist(ThisFunc, filename)
{
   if NOT FileExist(filename)
   {
      errord(ThisFunc, filename, "the aforementioned file does not exist")
      return false
   }
   return true
}

IsRegExMatch(Haystack, Needle)
{
   return RegExMatch(Haystack, Needle)<>""
}

Remap(input, remap1, replace1, remap2=0, replace2=0, remap3=0, replace3=0, remap4=0, replace4=0, remap5=0, replace5=0, remap6=0, replace6=0)
{
   if input=remap1
      return %replace1%
   if input=remap2
      return %replace2%
   if input=remap3
      return %replace3%
   if input=remap4
      return %replace4%
   if input=remap5
      return %replace5%
   if input=remap6
      return %replace6%
   return input
}

;I now think that moving to 0,0 is a better solution (most of the time)
MouseMoveRandom()
{
   WinGetPos, no, no, winWidth, winHeight
   Random, xCoordinate, 0, winWidth
   Random, yCoordinate, 0, winHeight
   MouseMove, xCoordinate, yCoordinate
}
;deprecated:
MoveToRandomSpotInWindow()
{
   MouseMoveRandom()
}

WeightedRandom(OddsOfa1, OddsOfa2, OddsOfa3=0, OddsOfa4=0, OddsOfa5=0)
{
   Random, input, 1, 100
   ;debug(input)
   OddsOfa2+=OddsOfa1
   OddsOfa3+=OddsOfa2
   OddsOfa4+=OddsOfa3
   OddsOfa5+=OddsOfa4
   if % input<=OddsOfa1
      return 1
   if % input<=OddsOfa2
      return 2
   if % input<=OddsOfa3
      return 3
   if % input<=OddsOfa4
      return 4
   if % input<=OddsOfa5
      return 5
   return 6
}

;TODO need to expand this so that it is called for each argument (warnings for true, false, 0, 1, or null string)
;Shows a debug message for a bool ("true" or "false")
DebugBool(bool)
{
   ;possible msgs:
   ;WARNING: This variable may be equal to false, 0, or may be undefined or empty
   ;WARNING: This variable may be equal to true or 1
   if (bool==1)
      msg:="This variable may be true or 1"
   else if (bool==0)
      msg:="This variable may be false or 0"
   else if (bool=="")
      msg:="This variable may be undef or an empty string"
   else
      msg:=bool
   ;Debug(msg) ;this must go before we put it into debug (endless recursion?)
   return msg
}

;TODO maybe get rid of this in favor of debugbool
;Change a boolean to a string (more readable)
BoolToString(bool)
{
   if (bool)
      return "true"
   else
      return "false"
}

;WRITEME
;Returns true if color1 is darker than color2
ColorIsDarkerThan(color1, color2)
{
;split into rgb numbers
;add rgb
;determine difference
}

;WRITEME
;Continuously checks a pixel's color until it stabilizes at a certain color
;returns the color that it is holding at
WaitUntilColorStopsChanging(x, y)
{
   PixelGetColor, lastColor, x, y
   while lastColor<>currentColor
   {
      PixelGetColor, currentColor, x, y
      Sleep, 50
   }
   return currentColor
}

;WRITEME
;Keeps clicking a spot until it is as dark/as light as possible
;(for selecting/deselecting a checkbox)
ForcePixelColorChangeByClicking(x, y, lightestOrDarkest, checkboxStates=2)
{
;MouseMove x, y
;current=WaitUntilColorStopsChanging(x, y)
;max=current
;Loop % checkboxStates
;{
;current=WaitUntilColorStopsChanging(x, y)
;if ColorIsDarkerThan(current, max)
;   max=current
;}
;while ColorIsDarkerThan(current, max)
;{
;
;current=WaitUntilColorStopsChanging(x, y)
;}
}

;Clicks at a specified location with ControlClick, MouseClick or Click
Click(xCoord, yCoord, options="Left Mouse")
{
   numberOfTimesToClick:=1
   if (InStr(options, "Double"))
      numberOfTimesToClick:=2

   Loop %numberOfTimesToClick%
   {
      if (InStr(options, "Standard"))
      {
         if (InStr(options, "Right"))
            Click, right, %xCoord%, %yCoord%
         else
            Click, left, %xCoord%, %yCoord%
      }
      else if (InStr(options, "Mouse"))
      {
         if (InStr(options, "Right"))
            MouseClick, right, %xCoord%, %yCoord%
         else
            MouseClick, left, %xCoord%, %yCoord%
      }
      else if (InStr(options, "Control"))
      {
         if (InStr(options, "Right"))
         {
            ;debug("r c")
            ControlClick, x%xCoord% y%yCoord%, , , RIGHT
         }
         else
            ControlClick, x%xCoord% y%yCoord%, , , LEFT
      }
      else
      {
         if (InStr(options, "Right"))
            Click, right, %xCoord%, %yCoord%
         else
            Click, left, %xCoord%, %yCoord%
      }
   }
}

;TODO write
;Closes a window as gracefully as possible
;TODO allow access by process?
CloseWindowGracefully(title, text="", xClickToClose="", yClickToClose="")
{
;Check if winexist each time (then return)

}

CurrentTime(options="")
{
   FormatTime, time,, yyyyMMddHHmmss
   returned := FormatTime(time, options)
   if InStr(options, "extended")
      returned .= "-" . A_TickCount
   return returned
}

;TODO enable slashes or colons?
;Gets the current time (unique, increasing)
; pass in a FormatTime-style string to customize your format
; or use one of the custom styles already thought up like hyphendate and slashdate
FormatTime(time, options="")
{
;use flags
;   date time datetime
;   separator
;   ordering? YYYYMMDD or MMDDYYYY
   if InStr(options, "hyphen")
      hyphen:=true
   if InStr(options, "slash")
      slash:=true
   if InStr(options, "colons")
      colon:=true
   if InStr(options, "date")
      date:=true
   if InStr(options, "time")
      time:=true
   if InStr(options, "zeropad")
      zeropad:=true
   if InStr(options, "year")
      month:=true
   if InStr(options, "month")
      time:=true

   if InStr(options, "slashdate")
      FormatTime, returned, %time%, MM/dd/yyyy
   else if InStr(options, "hyphenated")
      FormatTime, returned, %time%, yyyy-MM-dd_HH-mm-ss
   else if InStr(options, "hyphendate")
      FormatTime, returned, %time%, yyyy-MM-dd
   else if InStr(options, "wordsdate")
      FormatTime, returned, %time%, MMMM d, yyyy
   else if InStr(options, "month")
      FormatTime, returned, %time%, MM
   else if InStr(options, "year")
      FormatTime, returned, %time%, yyyy
   else if InStr(options, "date")
      FormatTime, returned, %time%, yyyyMMdd
   else if options
      FormatTime, returned, %time%, %options%
   else
      FormatTime, returned, %time%, yyyyMMddHHmmss

   ;got forced into using this
   return returned
}

;TESTME
DeFormatTime(timestamp)
{
   if RegExMatch(timestamp, "(\d{4}).(\d{2}).(\d{2}).(\d{2}).(\d{2}).(\d{2})", m)
   {
      returned=%m1%%m2%%m3%%m4%%m5%%m6%
      return returned
   }
   if RegExMatch(timestamp, "(\d{14})", m)
   {
      returned=%m1%
      return returned
   }
   if RegExMatch(timestamp, "(\d{2}).(\d{2}).(\d{4})", m)
   {
      returned=%m3%%m1%%m2%000000
      return returned
   }
   if RegExMatch(timestamp, "(\d{4}).(\d{2}).(\d{2})", m)
   {
      returned=%m1%%m2%%m3%000000
      return returned
   }
}

;FIXME does not account for 60-99 seconds, etc...
;Gets the current time so that later a time comparison is possible
CurrentTimePlus(seconds)
{
   return CurrentTime() + seconds
}

;WRITEME TESTME
TimePlus(one, two)
{
   returned:=0
   returned+=Mod(one, 100) + Mod(two, 100)
   ;one/=100
   ;two/=100
   returned+=one
   return returned
}

;Checks if the current time is before the time that is passed in
CurrentlyBefore(time)
{
   ;remove hyphens for flexibility
   time:=StringReplace(time, "-")
   return CurrentTime() < time
}

;Checks if the current time is after the time that is passed in
CurrentlyAfter(time)
{
   ;remove hyphens for flexibility
   time:=StringReplace(time, "-")
   return CurrentTime() > time

;i.e.:
;Debug("starting timer")
;TimeToStop:=CurrentTimePlus(2)
;while true
;{
;   sleep 100 ; CheckSomeFooBar()...
;
;   if (CurrentlyAfter(TimeToStop))
;      break
;}
;Debug(TimeToStop)

}

;Starts a timer--to be used in conjunction with ElapsedTime()
StartTimer()
{
   return A_TickCount
}

;TODO rename to StopTimer?
;Provides the elapsed time since StartTimer() was called
ElapsedTime(StartTime)
{
   if (StartTime = "")
      Errord("You didn't pass a valid StartTime in to the ElapsedTime() function.", "Be sure to use StartTimer() to get the start time.")
   returned := A_TickCount - StartTime
   return returned
}

;TODO write
;Formats a millisec-time into something a bit more pretty
PrettyTime(TimeToFormat)
{

}

;Determines if the specified window is minimized
IsMinimized(title="", text="")
{
   SetTitleMatchMode, RegEx
   WinGet, winstate, MinMax, %title%, %text%
   IfWinExist, %title%, %text%
   {
      if (winstate=-1)
         return true
   }
   return false
}

;Determines if the specified window is minimized
IsMaximized(title="", text="")
{
   SetTitleMatchMode, RegEx
   WinGet, winstate, MinMax, %title%, %text%
   IfWinExist, %title%, %text%
   {
      if (winstate=1)
         return true
   }
   return false
}

;Closes open applications that usually are difficult for windows to shut down (preps for a restart)
CloseDifficultApps()
{
   ProcessClose("SupervisionCore.exe")
   ProcessClose("SupervisionCore1.exe")
   ProcessClose("SupervisionCore2.exe")
   ProcessClose("SupervisionCore3.exe")

   ProcessClose("winsplit.exe")
   ;ProcessClose("ssms.exe")
   ProcessClose("hpupdate.exe")
   ProcessClose("DesktopWeather.exe")
   ;ProcessCloseAll("ping.exe")
   ProcessCloseAll("javaw.exe")

   if ForceWinFocusIfExist("Irssi ahk_class PuTTY")
      Send, /quit Ragequit{ENTER}

   if ForceWinFocusIfExist("ahk_class VMPlayerFrame")
   {
      Sleep, 500
      ForceWinFocus("ahk_class VMPlayerFrame")
      Send, {ALT}fx
   }

   while true
   {
      IfWinNotExist ahk_class MozillaUIWindowClass
         break
      WinClose ahk_class MozillaUIWindowClass
   }

   while true
   {
      IfWinNotExist, Microsoft SQL Server Management Studio ahk_class wndclass_desked_gsk
         break
      WinClose, Microsoft SQL Server Management Studio ahk_class wndclass_desked_gsk
      WinWait, Microsoft SQL Server Management Studio ahk_class #32770, Save changes to the following items?, 5
      WinActivate, Microsoft SQL Server Management Studio ahk_class #32770, Save changes to the following items?
      if NOT ErrorLevel
         ControlClick, &No
   }

   while true
   {
      IfWinNotExist, pgAdmin III ahk_class wxWindowClassNR
         break
      WinClose, pgAdmin III ahk_class wxWindowClassNR
      WinWait, Query ahk_class #32770, Do you want to save changes?, 5
      WinActivate, Query ahk_class #32770, Do you want to save changes?
      if NOT ErrorLevel
         ControlClick, &No
   }

   while true
   {
      Process, Exist, chrome.exe
      pid:=ERRORLEVEL
      if NOT pid
         break
      PostMessage,0x111,65405,0,,ahk_pid %pid%
      Process, WaitClose, %pid%, 1

      ;if it exists
      Process, Exist, %pid%
      pid:=ERRORLEVEL
      if pid
      {
         ;debug("closing")
         Process, Close, %pid%
      }
   }
}

CloseDifficultAppsAllScreens()
{
   DetectHiddenWindows, On
   WinShow, SK Sync Server Version 1.0.01A ahk_class SunAwtFrame
   WinClose, SK Sync Server Version 1.0.01A ahk_class SunAwtFrame

   Loop 5
      Send, {BROWSER_BACK}

   Loop 5
   {
      Sleep, 100
      CloseDifficultApps()
      Send, {BROWSER_FORWARD}
   }

   ;NOTES: forcefield.exe is the stupid thing that comes with ZoneAlarm
   listOstuff = ssms.exe,vmware-vmx.exe,vmplayer.exe,FindAndRunRobot.exe,dsidebar.exe,hpupdate.exe,java.exe,ping.exe,ForceField.exe

   Loop, parse, listOstuff, CSV
      ProcessCloseFifty(A_LoopField)
      ;ProcessCloseAll(A_LoopField)
}

;WRITEME
;Returns true if the specified path is a directory, false if it is a file (even if it doesn't exist yet)
;WRITEME
;Returns true if the specified path is a file, or false if it is a directory

;TODO Perhaps this should be done with other items, like the windows user folder, or like the dropbox folder
;Returns the correct program files location (error message if the file doesn't exist)
ProgramFilesDir(relativePath)
{
   ;ensure that the rel path starts with a slash
   if NOT SubStr(relativePath, 1, 1)="\"
      relativePath=\%relativePath%

   ;test the standard dir
   baseDir:="C:\Program Files"
   stdPath=%baseDir%%relativePath%
   if (FileExist(stdPath))
      return stdPath

   ;test the x86 dir
   x86:=" (x86)"
   x86Path=%baseDir%%x86%%relativePath%
   if (FileExist(x86Path))
      return x86Path

   Errord(A_ThisFunc, "was not able to find 'relativePath':", relativePath)
}

QuickFileOutput(text)
{
   timestamp := CurrentTime("hyphenated")
   file=C:\Dropbox\fastData\quickFileOutput\%timestamp%-%A_ComputerName%.txt
   FileCreate(text, file)
}

;Debug vs Errord: Silent/Traytip/Msgbox/Overlay, Logged/Not, Info/Warning/Error
;
;Send an error message with as many parameters as necessary, save debug information to dropbox logs section
debug(textOrOptions="Hello World!", text1="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text2="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text3="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text4="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text5="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text6="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text7="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text8="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text9="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text10="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text11="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text12="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text13="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text14="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text15="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ")
{
   loggedMode:=false
   silentMode:=false
   trayMsgMode:=false
   errordMode:=false
   printToTraceMode := true
   printToIniMode := true
   displayTime=2
   if (InStr(textOrOptions, "trayMsg"))
      trayMsgMode := true
   if (InStr(textOrOptions, "silent"))
      silentMode := true
   if (InStr(textOrOptions, "log"))
      loggedMode := true
   if (InStr(textOrOptions, "noLog"))
      loggedMode := false
   if (InStr(textOrOptions, "errord"))
   {
      errordMode := true
      displayTime = 60
   }
   if (InStr(textOrOptions, "noTimeout"))
      displayTime := ""
   ;TODO screenshot mode for debug() fcn
   ;if (InStr(textOrOptions, "screenshot"))
   ;{
      ;savescreenshot()
      ;append filename to the end of the debug message
   ;}

   ;TODO email/SMS error mode for debug() fcn
   ;this is probably a bad idea... just leave it in FastNotification()

   if NOT IsMyCompy()
   {
      ;TODO make a debug state for getting rid of Dropbox output in Lnx functions
      printToTraceMode := false
      printToIniMode := false
   }

   ;put together the message
   if (errordMode)
      messageTitle:="ERROR: "
   else
      messageTitle:="Debug: "
   messageTitle.=CurrentTime("hyphenated")
   messageTitle.=A_Space
   messageTitle.=A_ScriptFullPath

   messageText:="`n   " . textOrOptions
   loop 15
   {
      ;TODO make that true,false,undef helper function for helpful debug suggestions
      ;TODO if the one before has a colon at the end, then just add a space instead of a newline
      if (text%A_Index% == "ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ")
         break
      messageText.="`n   " . DebugBool( text%A_Index% )
   }
   messageText.="`n`n"

   ;log the message right away
   if loggedMode
   {
      logMessage=%messageTitle% %messageText%
      ;logPath=C:\Dropbox\Public\logs
      ;logFile=%A_ComputerName%.txt
      date := CurrentTime("hyphendate")
      if IsMyCompy()
         logFileFullPath=C:\Dropbox\Public\logs\%A_ComputerName%.txt
      else
         logFileFullPath=C:\inetpub\logs\%date%.txt

      FileAppend(logMessage, logFileFullPath)
   }

   ;display info to the user
   if NOT silentMode
   {
      if trayMsgMode
      {
         if (errordMode)
            TrayMsg("AHK Error", messageText, 20, 3)
         else
            TrayMsg("AHK Debug", messageText, 20, 3)
      }
      else if overlayMode
         msgbox, , %messageTitle%, %messageText%, %displayTime%
      else
         msgbox, , %messageTitle%, %messageText%, %displayTime%
   }

   ;print to ini (iniFpp) I put this in so we could keep some stats for how often this stuff happens
   ;this way I can view it in a unified IniFolder on my work PC each morning
   if printToIniMode
   {
      iniF := GetPath("MainStatsIniFolder")
      iniFkey=%textOrOptions% %text1%
      iniFvalue := IniFolderRead(iniF, "", iniFkey)
      iniFvalue++
      IniFolderWrite(iniF, "", iniFkey, iniFvalue)
   }

   ;print to trace file
   if printToTraceMode
   {
      AddToTrace(textOrOptions, text1, text2, text3, text4, text5, text6, text7, text8, text9, text10, text11, text12, text13, text14, text15)
      ;Trace2(textOrOptions, text1, text2, text3, text4, text5, text6, text7, text8, text9, text10, text11, text12, text13, text14, text15)
   }

   return textOrOptions
}

errord(textOrOptions="Hello World!", text1="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text2="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text3="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text4="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text5="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text6="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text7="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text8="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text9="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text10="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text11="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text12="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text13="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text14="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text15="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ")
{
   textOrOptions=LOG ERRORD %textOrOptions%
   debug(textOrOptions, text1, text2, text3, text4, text5, text6, text7, text8, text9, text10, text11, text12, text13, text14, text15)
   return textOrOptions
}

fatalErrord(textOrOptions="Hello World!", text1="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text2="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text3="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text4="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text5="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text6="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text7="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text8="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text9="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text10="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text11="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text12="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text13="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text14="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text15="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ")
{
   textOrOptions=FATAL %textOrOptions%
   errord(textOrOptions, text1, text2, text3, text4, text5, text6, text7, text8, text9, text10, text11, text12, text13, text14, text15)
   ExitApp
}

delog(textOrOptions="Hello World!", text1="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text2="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text3="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text4="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text5="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text6="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text7="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text8="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text9="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text10="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text11="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text12="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text13="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text14="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text15="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ")
{
   textOrOptions=SILENT LOG %textOrOptions%
   debug(textOrOptions, text1, text2, text3, text4, text5, text6, text7, text8, text9, text10, text11, text12, text13, text14, text15)
   return textOrOptions
}

SelfDestruct()
{
   FileDelete(A_ScriptFullPath)
   ;FileDelete(A_ScriptDir . "\" . A_ScriptName)
}

;TODO ahkFile does NOT support full paths yet.
; maybe make that supported in the future
CompileAhk(ahkFile, options="")
{
   ErrordIfFileNotExist(A_ThisFunc, ahkFile)

   ;WRITEME FileGetNameNoExt(), FileGetExt(), FileGetParentDir(localPath)
   ;Get the File name, get the file path (later we might want to get the file name without ext
   Loop, %ahkFile%
   {
      filename := A_LoopFileName
      filepath := A_LoopFileFullPath
      fileCount++
   }
   if NOT (fileCount == 1)
      errord(A_LineNumber, A_ScriptName, A_ThisFunc, A_ThisLabel, "file count should have been 1", fileCount, ahkFile)

   timer:=StartTimer()
   if NOT SuccessfullyCompiles(filepath)
      fatalerrord("Looks like this file doesn't compile correctly:" . ahkfile)
   addtotrace(elapsedtime(timer) . " SuccessfullyCompiles")

   timer:=StartTimer()
   ;path := StringReplace(filepath, filename)
   filename := RegExReplace(filename, "\.ahk$")

   ;exePath=%path%%filename%.exe
   exePath=%filename%.exe

   ;Compile that friggin ahk
   FileDelete(exePath)
   WaitFileNotExist(exePath)
   Sleep, 100
   ;Sleep, 1000

   ahk2exe:=ProgramFilesDir("AutoHotkey\Compiler\Ahk2Exe.exe")
   if InStr(options, "MitsiIcon")
      optionalIcon=/icon "C:\Dropbox\AHKs\ico\mtsi_0001.ico"

   cmd="%ahk2exe%" /in "%ahkFile%" %optionalIcon% /nodecompile
   CmdRet_RunReturn(cmd)
   ;WaitFileExist(exePath)

   ErrordIfFileNotExist(A_ThisFunc, exePath)
   addtotrace(elapsedtime(timer) . " Final Compile")

   return exePath
}

SuccessfullyCompiles(ahkPath)
{
   testOutPath=%A_Temp%\compileahk.txt
   testAhk=%A_Temp%\compileahk.ahk

   if NOT FileExist(ahkPath)
      return false

   text=
   (
   FileAppend, %ahkPath%, %testOutPath%
   ExitApp

   #include %ahkPath%
   )

   FileCreate("started compile text`n", testOutPath)
   FileCreate(text, testAhk)

   ;TODO choose one way or the other
   ;Run, %testAhk%
   ;Sleep, 1000
   RunWait, %testAhk%
   Sleep, 100
   ;Sleep, 500

   results:=FileRead(testOutPath)
   FileDelete(testOutPath)
   FileDelete(testAhk)
   ;debug(results)

   returned := !!InStr(results, ahkPath)
   return returned
}

;TODO move this to persistent - but if we move this to persistent, we won't be able to return if there was an error...
;  if we really wanted to return error state, maybe we could do UseErrorLevel, but i think that only applies to EXEs, not sure (prob won't catch AHK compile errors)
RunAhkAndBabysit(filename)
{
   if NOT FileExist(filename)
      errord("silent", A_ThisFunc, filename, "file was not found")

   SetTitleMatchMode, RegEx

   Run, %filename%

   WinWait, %filename%, (The program will exit|The previous version will remain in effect), 10
   sawErrorWindow := NOT ERRORLEVEL
   if sawErrorWindow
   {
      WinGetText, textFromTheWindow
      ControlClick, OK, %filename%
      errord("silent", A_ThisFunc, filename, "AHK file had an error...", textFromTheWindow, "... end of error msg")
      return "error"
   }
}

;options param for AHK_L
;options param for
;TODO make an options param for wait and babysit?
;can you even wait and babysit at the same time?
RunAhk(filename, params="", options="")
{
   if NOT FileExist(filename)
   {
      errord(A_ThisFunc, filename, "the aforementioned file does not exist")
      return false
   }

   command=AutoHotkey.exe %filename% %params%
   ;command=C:\Program Files (x86)\AutoHotkey\AutoHotkey.exe %filename% %params%
   if InStr(options, "wait")
      RunWait %command%
   else
      Run %command%
}

;Run a program (specify nickname or exe name)
;TODO maybe we could have an "ensure one instance" option
RunProgram(pathOrAppFilenameOrAppNickname)
{
   quote="
   params:=pathOrAppFilenameOrAppNickname
   params    := EnsureEndsWith(params, quote)
   params    := EnsureStartsWith(params, quote)
   RunAhk("FindAndRunProgram.ahk", params, "wait")
}

sendEmail(sSubject, sBody, sAttach="", sTo="cameronbaustian@gmail.com", sReplyTo="cameronbaustian+bot@gmail.com")
{
   timestamp := CurrentTime()
   path=C:\DataExchange\SendEmail
   file=%path%\%timestamp%.txt
   sBody:=RegExReplace(sBody, "(`r`n)", "ZZZnewlineZZZ")
    sBody:=RegExReplace(sBody, "(`r|`n)", "ZZZnewlineZZZ")
   FileCreateDir, %path%
   IniWrite, %sSubject%, %file%, pendingEmail, subject
   IniWrite, %sAttach%, %file%, pendingEmail, attach
   IniWrite, %sTo%, %file%, pendingEmail, to
   IniWrite, %sReplyTo%, %file%, pendingEmail, replyto
   IniWrite, %sBody%, %file%, pendingEmail, body

   Run, SendQueuedEmails.ahk
}

GetProcesses()
{
   d = `n  ; string separator
   s := 4096  ; size of buffers and arrays (4 KB)

   Process, Exist  ; sets ErrorLevel to the PID of this running script
   ; Get the handle of this script with PROCESS_QUERY_INFORMATION (0x0400)
   h := DllCall("OpenProcess", "UInt", 0x0400, "Int", false, "UInt", ErrorLevel)
   ; Open an adjustable access token with this process (TOKEN_ADJUST_PRIVILEGES = 32)
   DllCall("Advapi32.dll\OpenProcessToken", "UInt", h, "UInt", 32, "UIntP", t)
   VarSetCapacity(ti, 16, 0)  ; structure of privileges
   NumPut(1, ti, 0)  ; one entry in the privileges array...
   ; Retrieves the locally unique identifier of the debug privilege:
   DllCall("Advapi32.dll\LookupPrivilegeValueA", "UInt", 0, "Str", "SeDebugPrivilege", "Int64P", luid)
   NumPut(luid, ti, 4, "int64")
   NumPut(2, ti, 12)  ; enable this privilege: SE_PRIVILEGE_ENABLED = 2
   ; Update the privileges of this process with the new access token:
   DllCall("Advapi32.dll\AdjustTokenPrivileges", "UInt", t, "Int", false, "UInt", &ti, "UInt", 0, "UInt", 0, "UInt", 0)
   DllCall("CloseHandle", "UInt", h)  ; close this process handle to save memory

   hModule := DllCall("LoadLibrary", "Str", "Psapi.dll")  ; increase performance by preloading the libaray
   s := VarSetCapacity(a, s)  ; an array that receives the list of process identifiers:
   c := 0  ; counter for process idendifiers
   DllCall("Psapi.dll\EnumProcesses", "UInt", &a, "UInt", s, "UIntP", r)
   Loop, % r // 4  ; parse array for identifiers as DWORDs (32 bits):
   {
      id := NumGet(a, A_Index * 4)
      ; Open process with: PROCESS_VM_READ (0x0010) | PROCESS_QUERY_INFORMATION (0x0400)
      h := DllCall("OpenProcess", "UInt", 0x0010 | 0x0400, "Int", false, "UInt", id)
      VarSetCapacity(n, s, 0)  ; a buffer that receives the base name of the module:
      e := DllCall("Psapi.dll\GetModuleBaseNameA", "UInt", h, "UInt", 0, "Str", n, "UInt", s)
      DllCall("CloseHandle", "UInt", h)  ; close process handle to save memory
      if (n && e)  ; if image is not null add to list:
         l .= n . d, c++
   }
   DllCall("FreeLibrary", "UInt", hModule)  ; unload the library to free memory
   Sort, l, C  ; uncomment this line to sort the list alphabetically
   ;MsgBox, 0, %c% Processes, %l%
   return l
}

;Gets the total cpu usage from the computer over a period of time
GetTotalCpuUsage(Period = 500)
{
   ;retrieve the idle time and the tick time
   IdleBefore := 0
   DllCall("GetSystemTimes","Int64*",IdleBefore,"UInt",0,"UInt",0)
   TimerBefore := 0
   DllCall("QueryPerformanceCounter","Int64*",TimerBefore)

   ;wait for a predefined period
   Sleep, %Period%

   ;retrieve the idle time and the tick time after the wait period
   IdleAfter := 0
   DllCall("GetSystemTimes","Int64*",IdleAfter,"UInt",0,"UInt",0)
   TimerAfter := 0
   DllCall("QueryPerformanceCounter","Int64*",TimerAfter)

   ;retrieve the number of processing cores
   VarSetCapacity(Temp1,36,0)
   DllCall("GetNativeSystemInfo",A_PtrSize ? "UPtr" : "UInt",&Temp1)
   CPUCount := NumGet(Temp1,20)

   ;retrieve the tick frequency
   TicksPerMillisecond := 0
   DllCall("QueryPerformanceFrequency","Int64*",TicksPerMillisecond)

   ;calculate the actual idle time and tick time
   IdleTime := (IdleAfter - IdleBefore) / (CPUCount * 100)
   TickTime := (TimerAfter - TimerBefore) / (TicksPerMillisecond / 1000)

   ;calculate the CPU usage from the ratio of the times
   Usage := 100 - (IdleTime / TickTime)

   ;return the CPU usage, clamped to a range between 0 and 100, inclusive
   Return, (Usage < 0) ? 0 : Usage
}

GetCpuUsage( ProcNameOrPid )
{
   Process, Exist, %ProcNameOrPid%
   pid := Errorlevel
   if NOT pid
      pid := ProcNameOrPid

   Static oldKrnlTime, oldUserTime
   Static newKrnlTime, newUserTime

   oldKrnlTime := newKrnlTime
   oldUserTime := newUserTime

   hProc := DllCall("OpenProcess", "Uint", 0x400, "int", 0, "Uint", pid)
   DllCall("GetProcessTimes", "Uint", hProc, "int64P", CreationTime, "int64P", ExitTime, "int64P", newKrnlTime, "int64P", newUserTime)

   DllCall("CloseHandle", "Uint", hProc)
   Return Round( (newKrnlTime-oldKrnlTime + newUserTime-oldUserTime)/10000000 * 100 ,2)
}

GetRamUsage(ProcNameOrPid, Units="K")
{
   Process, Exist, %ProcNameOrPid%

   pid := Errorlevel
   if NOT pid
      pid := ProcNameOrPid

   ; get process handle
   hProcess := DllCall( "OpenProcess", UInt, 0x10|0x400, Int, false, UInt, pid )

   ; get memory info
   PROCESS_MEMORY_COUNTERS_EX := VarSetCapacity(memCounters, 44, 0)
   DllCall( "psapi.dll\GetProcessMemoryInfo", UInt, hProcess, UInt, &memCounters, UInt, PROCESS_MEMORY_COUNTERS_EX )
   DllCall( "CloseHandle", UInt, hProcess )

   SetFormat, Float, 0.0 ; round up K

   PrivateBytes := NumGet(memCounters, 40, "UInt")
   if (Units == "B")
      return PrivateBytes
   if (Units == "K")
      Return PrivateBytes / 1024
   if (Units == "M")
      Return PrivateBytes / 1024 / 1024
}

;Returns whether or not two files are equal
;TODO make this work for big files, too (this version reads it all into memory first)
IsFileEqual(filename1, filename2)
{
   FileRead, file1, %filename1%
   FileRead, file2, %filename2%

   return file1==file2
}

;TESTME
WaitFileExist(filename)
{
   while NOT FileExist(filename)
   {
      Sleep 100
   }
}

;TESTME (seemed to work well in previous context: de-queueing scheduled ahks)
WaitFileNotExist(filename)
{
   while (FileExist(filename))
   {
      Sleep 100
   }
}

;TODO return the name of the window that it saw instead and allow inf. windows to watch for
;TODO custom title match mode
;TESTME
DualWinWait(successWin, failureWin)
{
   while true
   {
      IfWinActive, %successWin%
         return "SUCCESS"

      IfWinActive, %failureWin%
         return "FAILURE"

      Sleep 50
   }
}

;FIXME seems that traytips don't work sometimes when the PC hasn't been rebooted in a while
;Displays a message in a bubble near the tray
TrayMsg(Title, Text="", TimeInSeconds=20, Icon=1, Options="")
{
   ;Was considering making this run in a separate thread so that the script could proceed without having to wait for the quote bubble to close, but that seems like it would be a lot of work, and if several bubbles popped up right in a row they would run one over the other...
   ;TODO perhaps someday i should make the thread pause for two seconds, then display the bubble for the remaining seconds (to allow it to be seen clearly, but to also allow the ahk to keep going)
   ;TODO make the Icon option straight text for readability

   ;if text is blank, the tooltip won't display
   if (Text=="")
   {
      Text:=Title
      Title:=""
   }

   TrayTip, %Title%, %Text%, %TimeInSeconds%, %Icon%
   SleepSeconds(2)
}

CloseTrayTip(text)
{
   IfWinExist, ahk_class tooltips_class32
   {
      WinGet, ID, LIST,ahk_class tooltips_class32
      Loop, %id%
      {
         this_id := id%A_Index%
         ControlGetText, TTtext, , ahk_id %this_id%
         if (InStr(TTtext, text))
            WinClose ahk_id %this_id%
      }
   }
}

GetOS()
{
   dllresult:=(DllCall("GetVersion") & 0xFF)
   RegRead, vista7, HKLM, SOFTWARE\Microsoft\Windows NT\CurrentVersion, CurrentVersion

   ;yeah... i know it's a problem, no reason to keep filling up the logs with it anymore
   ;debug("silent log", A_ThisFunc, A_LineNumber, "Note: known errors here with detecting that Phosphorus is running Win7","A_ComputerName:", A_ComputerName, "A_OSVERSIONNUM:", A_OSVERSIONNUM, "A_OSVERSION:", A_OSVERSION, "Checked using DLLCALL:", dllresult, "Checked using regread:", vista7)

   if ( A_ComputerName == "PHOSPHORUS" )
      return "WIN_7"
   return %A_OSVersion%
}

;Gets size of the entire directory in bytes
DirGetSize(dirPath)
{
   FolderSize = 0
   Loop, %dirPath%\*.*, , 1
      FolderSize += %A_LoopFileSize%
   return %FolderSize%
}

;Fixes possible issues with folder paths
RepairPath(FullPath)
{
   returned := FullPath
   returned := RegExReplace(returned, "(\\|\/)$")
   returned := RegExReplace(returned, "(\\|\/){2}", "\")
   return returned
}

;Gets the deepest child's folder name
;TESTME figure out if this approach will actually work in real life
GetFolderName(FullPath)
{

   returned := FullPath
   returned := RepairPath(returned)
   returned := RegExReplace(returned, "^.*(\\|\/)")
   ;NOTE that we do not want to check if the dir exists, because we may be trying to create a directory path that doesn't exist yet
   return returned
}

;TODO also need a combobox prompt: provide option1|option2|option3
;TODO need to handle if the user hit cancel or the 'x' - "USER_CANCELLED"
;TODO default text in textbox
;Displays a standard prompt to the user
;if "folder" is specified in options, the prompt will be a folder chooser
Prompt(message, options="")
{
   returned:=""
   if (InStr(options, "folder"))
      FileSelectFolder, returned, , , %message%
   else
      InputBox, returned, , %message%

   if ErrorLevel
      return "ERROR"

   return returned
}

;yeah
SexPanther(SexPanther="SexPanther")
{
   IniRead, returned, C:\Dropbox\misc\config.ini, %SexPanther%, Panther
   IniRead, var, C:\Dropbox\misc\config.ini, %SexPanther%, Sex
   return returned . var
}

;Make a report file of all the files that match the given pattern in the specified directory
;NOTE that you need to include a wildcard at the end!
DirectoryScan(directoryToScan, reportFilePath="C:/Dropbox/Public/logs/trace.txt")
{


   time:=CurrentTime("hyphenated")
   timer:=StartTimer()
   count=0
   directoryToScan := EnsureEndsWith(directoryToScan, "\")
   Loop, %directoryToScan%*, 1, 1
   {
      FileAppend, %A_LoopFileFullPath%`n, %reportFilePath%
      count++
   }
   result:=ElapsedTime(timer)
   FileAppend, Time to complete: %result%ms`n, %reportFilePath%
   FileAppend, Total items: %count%`n, %reportFilePath%
   FileAppend, Current Time: %time%`n, %reportFilePath%
}

;returns url response rather than saving to a file
UrlDownloadToVar(URL, Proxy="", ProxyBypass="")
{
   AutoTrim, Off
   hModule := DllCall("LoadLibrary", "str", "wininet.dll")

   If (Proxy != "")
   AccessType=3
   Else
   AccessType=1
   ;INTERNET_OPEN_TYPE_PRECONFIG                    0   // use registry configuration
   ;INTERNET_OPEN_TYPE_DIRECT                       1   // direct to net
   ;INTERNET_OPEN_TYPE_PROXY                        3   // via named proxy
   ;INTERNET_OPEN_TYPE_PRECONFIG_WITH_NO_AUTOPROXY  4   // prevent using java/script/INS

   io_hInternet := DllCall("wininet\InternetOpenA"
   , "str", "" ;lpszAgent
   , "uint", AccessType
   , "str", Proxy
   , "str", ProxyBypass
   , "uint", 0) ;dwFlags

   iou := DllCall("wininet\InternetOpenUrlA"
   , "uint", io_hInternet
   , "str", url
   , "str", "" ;lpszHeaders
   , "uint", 0 ;dwHeadersLength
   , "uint", 0x80000000 ;dwFlags: INTERNET_FLAG_RELOAD = 0x80000000 // retrieve the original item
   , "uint", 0) ;dwContext

   If (ErrorLevel != 0 or iou = 0) {
   DllCall("FreeLibrary", "uint", hModule)
   return 0
   }

   VarSetCapacity(buffer, 512, 0)
   VarSetCapacity(NumberOfBytesRead, 4, 0)
   Loop
   {
     irf := DllCall("wininet\InternetReadFile", "uint", iou, "uint", &buffer, "uint", 512, "uint", &NumberOfBytesRead)
     NOBR = 0
     Loop 4  ; Build the integer by adding up its bytes. - ExtractInteger
       NOBR += *(&NumberOfBytesRead + A_Index-1) << 8*(A_Index-1)
     IfEqual, NOBR, 0, break
     ;BytesReadTotal += NOBR
     DllCall("lstrcpy", "str", buffer, "uint", &buffer)
     res = %res%%buffer%
   }
   ;StringTrimRight, res, res, 2

   DllCall("wininet\InternetCloseHandle",  "uint", iou)
   DllCall("wininet\InternetCloseHandle",  "uint", io_hInternet)
   DllCall("FreeLibrary", "uint", hModule)
   AutoTrim, on
   return, res
}

;return a string where each item is separated by the specified separator
ConcatWithSep(separator, text0, text1, text2="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text3="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text4="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text5="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text6="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text7="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text8="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text9="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text10="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text11="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text12="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text13="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text14="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ", text15="ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ")
{
   returned:=text0
   Loop 15
   {
      if (text%A_Index% == "ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ")
         break
      returned .= separator
      returned .= text%A_Index%
   }
   return returned
}

;figure out if this computer is a VM
;if no name is passed, it assumes the local machine
IsVM(ComputerName="")
{
   if (ComputerName=="")
      ComputerName:=A_ComputerName

   ;noticed that this needs to be at the end of the computername (2012-08-27)
   ;return !!InStr(ComputerName, "VM")
   return !!RegExMatch(ComputerName, "VM$")
}

;figure out if this computer is one I have ownership of (determines where we put some files)
;if no name is passed, it assumes the local machine
;honestly, this is a horrible way to figure it out
IsMyCompy(ComputerName="")
{
   if (ComputerName=="")
      ComputerName:=A_ComputerName
   ComputerName := StringUpper(ComputerName)

   return !!RegExMatch(ComputerName, "^(PHOSPHORUS|PHOSPHORUSVM|BAUSTIAN-09PC|T-800|BAUSTIAN12|BAUSTIANVM|SEWING-XP)$")
}

;Reload the core scripts(as if we just restarted the pc)
ForceReloadAll()
{
   RunWait, ForceReloadAll.exe
   ;CloseAllAhks("", "StartIdleAhks.ahk")
}

;Closes all ahks as gracefully as possible
CloseAllAhks(excludeRegEx="", startAhkAfter="")
{
   excludeRegEx   := EnsureEndsWith(excludeRegEx, quote)
   excludeRegEx   := EnsureStartsWith(excludeRegEx, quote)
   startAhkAfter   := EnsureEndsWith(startAhkAfter, quote)
   startAhkAfter   := EnsureStartsWith(startAhkAfter, quote)

   params:=concatWithSep(" ", excludeRegEx, startAhkAfter)
   RunAhk("CloseAllAhks.ahk", params, "wait")
}

;note that you can use the full path to the ahk
HowManyAhksAreRunning(specificAhk="")
{
   DetectHiddenWindows, On  ; Allows a script's hidden main window to be detected.
   SetTitleMatchMode, 2  ; Avoids the need to specify the full path of the file below.

   ;returned:=false
   WindowNeedle=%specificAhk% - AutoHotkey
   WinGet, id, LIST, %WindowNeedle%
   Loop, %id%
   {
      count++
      thisID:=id%A_Index%
      ahkIdStr=ahk_id %thisID%
      title:=wingettitle(ahkIdStr)

      allTitles .= "`n" . title
      ;regexmatch(title, "([A-Za-z0-9]*\.ahk)", smalltitle)
      ;pid := WinGet("pid", ahkIdStr)

      ;if NOT InStr(title, A_ScriptName) AND NOT RegExMatch(title, ExcludeRegEx)
      ;{
         ;returned:=true
         ;if InStr(options, "graceful")
            ;WinClose, %ahkIdStr%
         ;if InStr(options, "forceful")
            ;Process, Close, %pid%
      ;}
   }
   ;debug("this many ahks", count, allTitles)
   msg=found %count% ahks running as %specificAhk%
   addToTrace(msg, allTitles)

   return count
}

;TESTME
ZeroPad(number, length)
{
   ;Loop length
      ;padding .= "0"
   ;length *= -1
   ;length++

   ;returned := substr(padding . number, length)
   ;return returned

   while (strlen(number) < length)
      number := "0" . number

   return number
}

;WRITEME
IsDirFileOrIndeterminate(path)
{
;DirExist()
;FileExist()

;if it doesn't exist, then all we can do is make a guess
;if it ends with a slash it has got to be a dir

;if it has a one two or three or four letter extension, it is probably a file

}

trace2(var, t1="", t2="", t3="", t4="", t5="", t6="", t7="", t8="", t9="", t10="", t11="", t12="", t13="", t14="", t15="")
{
   if NOT IsMyCompy()
      return

   Loop 15
      var .= " " . t%A_Index%

   ;get rid of line breaks
   var := RegExReplace(var, "(\r|\n|\r\n)", " ")
   ;get rid of extra spaces at beginning and end
   var = %var%

   ;put an awesome timestamp on it
   datestamp := CurrentTime("hyphendate")
   timestamp := CurrentTime("hyphenated")
   var=%timestamp% %A_ComputerName%: %var%
   ;traceFile:=GetPath("trace.txt")
   tracePartsFile=C:\Dropbox\Public\logs\traceParts\%datestamp%-A_ComputerName.txt
   FileAppendLine(var, tracePartsFile)
}

;want to deprecate this in favor of trace2 (similar to iniFolder)
AddToTrace(var, t1="", t2="", t3="", t4="", t5="", t6="", t7="", t8="", t9="", t10="", t11="", t12="", t13="", t14="", t15="")
{
   if NOT IsMyCompy()
      return

   Loop 15
   {
      thisTextItem := t%A_Index%
      if (thisTextItem == "ZZZ-DEFAULT-BLANK-VAR-MSG-ZZZ")
         break
      var .= " " . thisTextItem
   }

   ;get rid of extra spaces at beginning and end
   var = %var%

   ;put an awesome timestamp on it
   var := CurrentTime("hyphenated") . " " . A_ComputerName . ": " . var
   traceFile:=GetPath("trace.txt")
   FileAppendLine(var, traceFile)
}

;want to deprecate this in favor of trace2 (similar to iniFolder)
DeleteTraceFile()
{
   ;lets archive it and create a new file real quick
   timestamp:=CurrentTime("hyphenated")
   archiveFile=C:\Dropbox\AHKs\gitExempt\logs\traceArchive\%timestamp%.log
   traceFile:=GetPath("trace.txt")

   FileMove(traceFile, archiveFile)
   FileAppendLine("TRACE!!!", traceFile)
}

;RegEx File Processor
REFP(inFile="REFP/in1.txt", regExFile="REFP/regex1.txt", outFile="REFP/out1.txt")
{
   quote="
   infile    := EnsureEndsWith(infile, quote)
   infile    := EnsureStartsWith(infile, quote)
   regExfile := EnsureEndsWith(regExfile, quote)
   regExfile := EnsureStartsWith(regExfile, quote)
   outfile   := EnsureEndsWith(outfile, quote)
   outfile   := EnsureStartsWith(outfile, quote)

   params:=concatWithSep(" ", inFile, regExFile, outFile)
   RunAhk("RegExFileProcessor.ahk", params, "wait")
}

;Ensure that the string given ends with a given char
EnsureEndsWith(string, char)
{
   if ( StringRight(string, strlen(char)) <> char )
      string .= char

   return string
}

;Ensure that the string given starts with a given char
EnsureStartsWith(string, char)
{
   if ( StringLeft(string, strlen(char)) <> char )
      string := char . string

   return string
}

;Instead of actually muting, lets just turn the volume all the way down
SpiffyMute()
{
   ;Turn the volume all the way down
   SoundSet, 0

   ;unmute the volume for consistency
   SoundSet, 1, , mute
   SoundSet, +1, , mute
}

;allows easy access to the contents of XML elements
;path will travel through the XML heirarchy, like: html.head.title
;note that this does not enforce proper traversal of the xml tree
;TODO allow for attributes to be present in the XML element we are searching for
;TODO allow for searching through XML arrays
GetXmlElement(xml, pathToElement)
{
   Loop, parse, pathToElement, .,
   {
      elementName:=A_LoopField
      regex=<%elementName%>(.*)</%elementName%>

      RegExMatch(xml, regex, xml)
      ;TODO switch to use xml1, instead of parsing stuff out
      ;errord("nolog", xml1)
      xml := StringTrimLeft(xml, strlen(elementName)+2)
      xml := StringTrimRight(xml, strlen(elementName)+3)
   }

   return xml
}

fatalIfNotThisPc(computerName)
{
   if (A_ComputerName <> computerName)
   {
      debug(A_ScriptName, A_ComputerName, "this script isn't designed to run on this pc", "it is only designed to run on the following pc", computerName)
      ExitApp
   }
}

;this is a candidate for merging with debug()
;but first options "threaded" "timeToWait=untilPressOkButton" and "hideDebugInfo" need to be implemented
;but right now I think it is different enough
ThreadedMsgbox(message)
{
   message="%message%"
   RunAhk("ThreadedMsgbox.ahk", message)
}

;tells the name of the lead computer
LeadComputer()
{
   return "PHOSPHORUS"
   ;return "BAUSTIAN-09PC"
}

MultiWinWait(successWin, successWinText, failureWin, failureWinText)
{
   while true
   {
      IfWinActive, %successWin%, %successWinText%
         return "SUCCESS"

      IfWinActive, %failureWin%, %failureWinText%
         return "FAILURE"

      Sleep 50
   }
}

;waits for the window to be active and then clicks the button (using alt+letter)
;this should result in code that is more readable: ClickButton("&Save")
ClickButton(button)
{
   ;TODO figure out if the button is visible in the wintext
   ;TODO hit the alt key for the button, if it has that & in the name (more reliable)

   ;ControlClick, %button%

   if NOT InStr(button, "&")
      fatalErrord("couldn't click the button", "it didn't have an & specified:", button)
   WinWaitActive, , %button%, 5
   if ErrorLevel
      fatalErrord("never saw window", "the window containing the button I was looking for never popped up", "gave up looking for the window after 5 seconds... perhaps you should put a longer wait in before calling ClickButton()", button)
   Sleep, 100
   button := StringLower(button)
   RegExMatch(button, "\&(.)", match)
   keys=!%match1%
   Send, %keys%
}

AddDatetime(datetime, numberToAdd, unitsOfNumberToAdd)
{
   ;TODO verify that datetime is a datetime
   ;TODO verify that number to add is a number
   ;TODO standardize naming of the units (m, mins, min, minute, minutes)
   ;TODO figure out current format of the timestamp
   datetime := DeFormatTime(datetime)
   datetime += %numberToAdd%, %unitsOfNumberToAdd%
   ;TODO restore previous format of the timestamp
   return datetime
}

Format(value, options)
{
   if ( InStr(options, "Dollar") OR InStr(options, "Money") )
   {
      RegExMatch(value, "(-{0,1})\${0,1}(-{0,1}\d*\.{0,1}\d{1,2})", match)
      return match1 . match2
      ;TODO allow values like $100 and $100.1... and 100 and 100.1
      ;if RegExMatch(value, "(-{0,1})\${0,1}(-{0,1}\d*.\d{2})", match)
         ;return match1 . match2
      ;else
         ;Errord("This value doesn't appear to be the correct type", A_ScriptName, A_LineNumber, A_ThisFunc, value, options)
   }
   else if InStr(options, "hyphendate")
   {
      RegExMatch(value, "(\d{4})(\d{2})(\d{2})(\d{6})?", m)
      returned=%m1%-%m2%-%m3%
      return returned
   }
}

InStrCount(String, Needle)
{
   StringReplace, String, String, %Needle%, , UseErrorLevel
   return ErrorLevel
}

;by Berban originally
RegExMatchCount(Count_String, Count_Needle, Count_Type="", Count_SubPattern="")
;{
   ;Global
   ;Local f := 0, n := 0, Output := 0
   ;If (Type = "") {
      ;StringReplace, String, String, %Needle%, , UseErrorLevel
      ;n := ErrorLevel
   ;} Else {
      ;While (f := RegExMatch(String, Needle, Output, f + StrLen(Output))) {
         ;n++
         ;If Type
            ;%Type%%n% := Output%SubPattern%
      ;}
      ;If Type
         ;%Type% := n
   ;}
   ;Return n
;}
{
   Global
   Count_n = 0
   If (Count_Type = "") {
      Count_g := StrLen(Count_Needle)
      Loop {
         Count_f := InStr(Count_String, Count_Needle) - 1
         If (Count_f = -1)
            Break
         Count_n++
         StringTrimLeft, Count_String, Count_String, % Count_f + Count_g
      }
   } Else {
      Loop {
         Count_f := RegExMatch(Count_String, Count_Needle, Count_Output) - 1
         If (Count_f = -1)
            Break
         Count_n++
         If Count_Type
            %Count_Type%%Count_n% := Count_Output%Count_SubPattern%
         StringTrimLeft, Count_String, Count_String, % Count_f + StrLen(Count_Output)
      }
      If Count_Type
         %Count_Type% := Count_n
   }
   Return Count_n
}

;have an option to leave markers where the line endings were? ZZZnewlineZZZ
RemoveLineEndings(page)
{
   return RegExReplace(page, "(`r|`n)", " ")
}

FormatDollar(amount)
{
   RegExMatch(amount, "-?(\d|,)*\.\d\d", returned)
   returned:=RegExReplace(returned, ",", "")
   return returned
}

MorningStatusAppend(header, item)
{
   text=%header%: %item%
   FileAppendLine(text, "gitExempt\morning_status\finance.txt")
}

GetPath(file)
{
   date := Currenttime("hyphendate")

   if (file = "NightlyStats.ini")
      return "C:\Dropbox\AHKs\gitExempt\NightlyStats.ini"
   else if (file = "RunOncePerDay.ini")
      return "C:\Dropbox\AHKs\gitExempt\RunOncePerDay.ini"
   else if (file = "LynxStats.ini")
      return "C:\Dropbox\AHKs\gitExempt\LynxStats.ini"
   else if (file = "MelFireflyConfig.ini")
      return "C:\Dropbox\AHKs\gitExempt\MelFireflyConfig.ini"
   else if (file = "config.ini")
      return "C:\Dropbox\Misc\config.ini"
   else if (file = "questions.ini")
      return "C:\Dropbox\Misc\questions.ini"
   else if (file = "FireflyFees.json")
      return "C:\Dropbox\AHKs\gitExempt\firefly\FireflyFees.json"
   else if (file = "FireflyIniFolder")
      return "C:\Dropbox\fastData\fireflyBotCommunication\inifParts\"
   else if (file = "FireflyCheckinIniFolder")
      return "C:\Dropbox\fastData\fireflyCheckins\inifParts\"
   else if (file = "FireflyStatsIniFolder")
      return "C:\Dropbox\fastData\fireflyStats\inifParts\"
   else if (file = "MainStatsIniFolder")
      return "C:\Dropbox\fastData\main\stats\inifParts\"
   else if (file = "MyStats.ini")
      return "C:\Dropbox\Public\logs\" . A_ComputerName . ".ini"
   else if (file = "MyConfig.ini")
      return "C:\Dropbox\Misc\config-" . A_ComputerName . ".ini"
   ;else if (file = "iMacro.lock")
      ;return "C:\Dropbox\Public\lock\imacro-" . A_ComputerName . ".lock"
   else if (file = "DailyFinancial.csv") ;deprecated
      return "C:\Dropbox\AHKs\gitExempt\DailyFinancial.csv"
   else if (file = "FinancialPast.csv")
      return "C:\Dropbox\AHKs\gitExempt\FinancialPast.csv"
   else if (file = "trace" OR file = "trace.txt")
      return "C:\Dropbox\Public\logs\trace.txt"
   else if (file = "lynx-generic")
      return "C:\temp\logs\" . date . "-generic.txt"
   else if (file = "lynx-logfile")
      return "C:\temp\logs\" . date . "-generic.txt"
   else if (file = "lynx-checkdb")
      return "C:\temp\logs\" . date . "-checkdb.txt"
   else if (file = "lynx-installall")
      return "C:\temp\logs\" . date . "-installall.txt"
   else if (file = "lynx-removeall")
      return "C:\temp\logs\" . date . "-installall.txt"
   else if (file = "logfile")
   {
      if IsMyCompy()
         return "C:\Dropbox\Public\logs\" . A_ComputerName . ".txt"
      else
         return "C:\temp\logs\" . date . "-generic.txt"
   }
   else if (file = "checkdb-logfile")
      return "C:\temp\logs\" . date . "-checkdb.txt"
   else if (file = "installall-logfile" OR file = "removeall-logfile")
      return "C:\temp\logs\" . date . "-installall.txt"
   errord("orange line", "tried to GetPath() for an unknown file", file)
   return ""
}

CommandPromptCopy()
{
   ;might not want to do this if it is already active
   ForceWinFocus("ahk_class ConsoleWindowClass")

   MouseClick, right, 13, 13
   Sleep 100
   Send, {UP 3}{RIGHT}{DOWN 3}
   Sleep 100
   Send, {ENTER}
   Sleep 100
   Send, {ENTER}
}

;maybe this should be moved to a nightly lib?
;write all this info out to the ini, csv and morning status email
;create the csv files afterward (pull the info from from the ini)
;;;TODO we could come up with the var name by getting rid of spaces
NightlyStats(title, data, options="")
{
   shouldEmail:=true

   if (title == "" OR data == "")
      return

   if InStr(options, "noemail")
      shouldEmail:=false

   ini:=GetPath("NightlyStats.ini")
   date:=CurrentTime("hyphendate")

   IniWrite(ini, date, title, data)
   IniWrite(ini, "MostRecent", title, data)

   if shouldEmail
      MorningStatusAppend(title, data)
}

RunOncePerDay(description)
{
   sectionKey:=description

   ini:=GetPath("RunOncePerDay.ini")
   dateKey=date
   currentDate:=CurrentTime("hyphendate")
   lastRunDate:=IniRead(ini, sectionKey, dateKey)

   if (currentDate == lastRunDate)
      return false

   IniWrite(ini, sectionKey, dateKey, currentDate)
   return true
}

;FIXME
;NOTE I hate the way this syntax looks
;isPlusOrMinus(cneterNumber, numbertocompare, plusOrMinus)
;{
   ;if (number)
   ;return num
;}

;Close the AHK using Process, Close
;TODO ensure that this only closes AHKs, and never closes the editor that the script is open in...
;FIXME doesn't seem to work at all, especially on SupervisionCore.ahk
AhkClose(ahkFilename)
{
   ;maybe we want to error out if there was no such ahk running at the time
   DetectHiddenWindows, On
   ;SetTitleMatchMode, Slow
   SetTitleMatchMode, 2
   WinGet, pid, PID, %ahkFilename% - AutoHotkey
   ;if ErrorLevel
      ;debug("there was error", errorlevel)
   debug("", A_ThisFunc, "pid, then errorlevel", pid, errorlevel)
   ;debug(pid, ahkFilename)
   ProcessClose(pid)
   CustomTitleMatchMode("Default")
   ;if pid
   ;{
      ;ProcessClose(pid)
      ;return true
   ;}
   ;else
      ;return false
   DetectHiddenWindows, Off
}

IsAhkRunning(ahkFilename)
{
   DetectHiddenWindows, On
   ;TODO make this a function IsAhkRunning() and include AutoHotkey in the title. (and allow regex)
   ahkFilename := EnsureEndsWith(ahkFilename, ".ahk")
   IfWinExist, %ahkFilename%
      return true
   else
      return false
   ;{
      ;BlockInput, MouseMoveOff
      ;AhkClose("fireflyButtons.ahk")
      ;RunAhk("fireflyButtons.ahk")
      ;reload
   ;}
   ;else
      ;RunAhk("fireflyButtons.ahk")
   DetectHiddenWindows, Off
}

GetFirefoxVersion(firefoxPath)
{
   folder:=ParentDir(firefoxPath)
   folder:=EnsureEndsWith(folder, "\")
   iniPath=%folder%application.ini
   version:=IniRead(iniPath, "App", "Version")
   return version
}

GetRandomNumber()
{
   return 4  ;chosen by fair dice roll.
             ;guaranteed to be random.
}

ConvertVersionNumToInt(versionNum)
{
   versionNum:=RegExMatch(versionNum, "^(\d+)", match)
   versionNum:=match
   return versionNum
}

;In case you were wondering, GetRandomNumber() is definitely a reference to XKCD. Good job catching that reference.

;TESTME
IsAhkCurrentlyRunning(ahk)
{
   SetTitleMatchMode, 2
   DetectHiddenWindows, On
   ahk := EnsureEndsWith(ahk, ".ahk")
   WinGet, pid, PID, %ahk% - AutoHotkey
   DetectHiddenWindows, Off
   CustomTitleMatchMode("Default")
   returned := !!pid
   return returned
}

;Wait until the title of the active window changes
;(note that changing to another window sets it off, too)
WinWaitActiveTitleChange(oldTitle="")
{
   ;if they didn't give a title, try to grab the title as quickly as possible
   ;this is less reliable, but if we don't have the title, we'll just do the best we can
   if (oldTitle == "")
      WinGetActiveTitle, oldTitle

   ;loop until the window title changes
   Loop
   {
      WinGetActiveTitle, newTitle
      if (oldTitle != newTitle)
         break
      Sleep, 100
   }
}

SendSlow(textToSend, pauseTime=500)
{
   Loop, parse, textToSend
   {
      ;only pause between each of the letters of the word
      if textSendInProgress
         Sleep, %pauseTime%

      Send, %A_LoopField%
      textSendInProgress:=true
   }
}

;thanks to berban for this one
;takes a time in milliseconds and displays it in a readable fashion
;RENAMEME
PrettyTickCount(timeInMilliSeconds)
{
   ElapsedHours := SubStr(0 Floor(timeInMilliSeconds / 3600000), -1)
   ElapsedMinutes := SubStr(0 Floor((timeInMilliSeconds - ElapsedHours * 3600000) / 60000), -1)
   ElapsedSeconds := SubStr(0 Floor((timeInMilliSeconds - ElapsedHours * 3600000 - ElapsedMinutes * 60000) / 1000), -1)
   ElapsedMilliseconds := SubStr(0 timeInMilliSeconds - ElapsedHours * 3600000 - ElapsedMinutes * 60000 - ElapsedSeconds * 1000, -2)
   returned := ElapsedHours "h:" ElapsedMinutes "m:" ElapsedSeconds "s." ElapsedMilliseconds
   return returned
}

PreviewCsv(csvContents)
{
   csvFile := "C:\Dropbox\temp\" . CurrentTime("hyphenated") . ".csv"
   FileAppend(csvContents, csvFile)

   quote="
   csvFile:=EnsureStartsWith(csvFile, quote)
   csvFile:=EnsureEndsWith(csvFile, quote)
   CmdRet_RunReturn("C:\Dropbox\Programs\SnapDB\SnapDB.exe " . csvFile)
}

IsVmRunning()
{
   CustomTitleMatchMode("RegEx")
   winTitle=.+ - VMware Player ahk_class VMPlayerFrame
   ;return WinExist(winTitle)
   returned := false
   IfWinExist, %winTitle%
      returned := true
   CustomTitleMatchMode("Default")

   return returned
}

OpenVM()
{
   vmFile := "C:\XPVM\Windows XP Professional.vmx"
   ErrordIfFileNotExist(ThisFunc, vmFile)
   Run, %vmFile%
}

ScheduleRemoteAhk(ahkContents, targetComputer)
{
   if NOT isMyCompy(targetComputer)
   {
      errord("The target computer is not one of my conputers", A_LineNumber, A_ScriptName, A_ThisFunc, A_ThisLabel, targetComputer)
      return
   }

   ;TODO I would prefer to compile the AHK here first, and fail immediately if it does not compile
   ;DECISIONS need to figure out if I actually want to compile it in the same folder. I'm thinking that is a bad idea
   ;quick write temp file
   ;if NOT SuccessfullyCompiles(ahkPath)
   ;{
      ;errord("This ahk didn't compile", A_LineNumber, A_ScriptName, A_ThisFunc, A_ThisLabel, targetComputer)
      ;QuickFileOutput(ahkContents)
      ;return
   ;}
   ;delete the temp file

   time:=CurrentTime()
   ;computerName:=Prompt("What computer do you want to schedule this ahk for?")
   ;ahkContents:=Prompt("Enter the text of your ahk here:")

   filename=C:\Dropbox\AHKs\scheduled\%targetComputer%\%time%.ahk
   ;FileCopy, C:\Dropbox\AHKs\template.ahk, %filename%, 1
   FileCopy("C:\Dropbox\AHKs\template.ahk", filename, "overwrite")
   ahkContents:=StringReplace(ahkContents, "``n", "`n")

   ;FileAppend, %ahkContents%, %filename%
   FileAppend(ahkContents, filename)
}

;should show the newest modified date out of all the files in that folder
;gives the last modified date of the most recently modified file in the folder
;TESTME not yet sure if it is perfect
;WRITEME this definitely does not work yet
FileDirGetModifiedDate(path)
{
   ;datestamp := CurrentTime("hyphendate")
   ;needle=^%datestamp%

   Loop, %IniFolder%*
   {
      ;deout .= "`n"
      ;shouldArchive := true
      ;destination=%IniFolder%archive\%A_LoopFileName%

      ;if RegExMatch(A_LoopFileName, needle)
         ;shouldArchive := false

      if (thisModifiedDate > maxModifiedDate)
      {
         ;deout .= "ARCHIVE  "
         ;FileMove(A_LoopFileFullPath, destination)
         ;archivedFile := true
         maxModifiedDate := thisModifiedDate
      }

      ;deout .= A_LoopFileFullPath
      ;deout .= " moved to "
      ;deout .= destination
   }
   ;debug("errord nolog", deout)

   if true
   {
      ;;AddToTrace("yellow line - archived old fees files")
      ;;QuickFileOutput("archived files:`n" . deout)
   }
   return maxModifiedDate
}

;WRITEME make function for getting remote and local path of dropbox public folder
GetDropboxPath(path, remoteOrLocal)
{
   if NOT RegExMatch(remoteOrLocal, "^(local|remote)$")
      fatalerrord(A_ThisFunc, A_ScriptPath, A_LineNumber, "The only two options for the RemoteOrLocal Param are Remote Or Local, please obey usage guidelines.")

   remotePath := "http://dl.dropbox.com/u/789954"
   localPath := "C:\Dropbox\Public"
   returned := path

   ;if InStr(remoteOrLocal, "remote")
      ;returned := RegExReplace(returned)
   ;else if InStr(remoteOrLocal, "local")
      ;returned := RegExReplace(returned)

   ;http://dl.dropbox.com/u/789954/remotewidget.txt
   ;C:\Dropbox\Public\logs\%A_ComputerName%.txt

   ;if InStr(remoteOrLocal, "remote")
      ;WRITEME returned := ConvertToForwardSlashes(returned)
   ;else if InStr(remoteOrLocal, "local")
      ;WRITEME returned := ConvertToBackSlashes(returned)

   return returned
}

;notify me wherever I am, as quickly as possible
;display a msgbox, and if that isn't acknowledged in a reasonable timeframe, then send an SMS
FastNotification(message)
{
   fatalIfNotThisPc("PHOSPHORUS")

   ;display a msgbox first and see if I'm at the computer
   delog("", "Sending a FastNotification()", message)
   MsgBox, , , %message%, 30
   IfMsgBox Timeout
   {
      SendSmsCorrectlyButGhetto(message, "9723429753")
   }
}

;Sends a text message from the bot
;Uses iMacros to send from Google Voice
SendSmsCorrectlyButGhetto(message, number)
{
   ;send text using google voice

   RunProgram("C:\Program Files\Mozilla Firefox\firefox.exe")
   panther:=SexPanther()
   timestamp:=CurrentTime("hyphenated")
   imacro=
   (
   TAB CLOSEALLOTHERS
   URL GOTO=http://mail.google.com/mail/u/0/?logout&hl=en
   URL GOTO=http://www.gmail.com
   TAG POS=1 TYPE=INPUT:TEXT FORM=ACTION:https://accounts.google.com/ServiceLoginAuth ATTR=ID:Email CONTENT=cameronbaustianbot@gmail.com
   SET !ENCRYPTION NO
   TAG POS=1 TYPE=INPUT:PASSWORD FORM=ACTION:https://accounts.google.com/ServiceLoginAuth ATTR=ID:Passwd CONTENT=%panther%
   TAG POS=1 TYPE=INPUT:SUBMIT FORM=ID:gaia_loginform ATTR=ID:signIn
   URL GOTO=http://www.google.com/voice
   )

   RunIMacro(imacro)
   Sleep, 1500
   Send, m
   Sleep, 1500
   ;Sleep, 100
   Send, %number%
   Sleep, 500
   Send, {TAB}
   Sleep, 500
   Send, %message%
   Sleep, 500
   Send, {TAB}
   Sleep, 500
   Send, {ENTER}
   Sleep, 1500
   Send, ^w
}


;WRITEME split csv processing out of the create pie chart macro
;WRITEME make monthly financial charts (rather than three-month)

;TODO error if Click() is outside the bounds of the window
;TODO error if Click() is control-clicking on a button that is not in the visible window text

;WRITEME parse and display TODO and WRITEME items from FcnLib
;WRITEME try to run MintTouch once an hour on the VM
;WRITEME macro that updates melinda's resume daily
;WRITEME close specified jira issue (and log work beforehand, too)
;WRITEME abort startup ahk if already started up (after VPNed)
;WRITEME RunDailyTask("HH:MM:SS", "PHOSPHORUS", "asdf.ahk", "params") ;need to make sure it calls SleepSeconds(2) at the end of it
;WRITEME macro that updates melinda's resume daily
;WRITEME close specified jira issue (and log work beforehand, too)

;WRITEME parse the following pages and put them in the morning status
;perhaps i can have updates of my points position, rather than having to look it up ;use blazin pedals site
;WRITEME make widget that will display the latest warnings and debug info (like baretail, but open all the time)
;WRITEME use autologin to make a script that closes out the VPN connection gracefully
   ;WRITEME WinClose(text, title, options) that allows match modes, and also allows the "Gentle" option described in the docs (PostMessage)

;WRITEME archive log files on a periodic basis, debug and trace and ini
;WRITEME archive log files monthly, archive trace file nightly
;WRITEME use TodWulff lib for url shortening urls that are on the clipboard

;WRITEME improve queueing of the three types of queued ahks
;WRITEME fix the 3 types of queued AHKs - nightly, scheduled, and persistent-timed - figure out what the specs really are for each category and why they are different
;WRITEME fix GetOS() - run cmd prompt on startup and get version and save it
;WRITEME FIXME issues where infiniteloop.ahk is run during nightly, but doesn't show as "unfinished" the next morning
;WRITEME fileappendlinecsv
;WRITEME formatdollar()
;WRITEME method to "test compile" each ahk function lib individually and return if it compiles successfully (well, run it, not compile to exe)

;WRITEME make a function so i can use gocr easily
;WRITEME experiment with a log file using ini (or a trace file)
;WRITEME make FinancialProjection.csv work with new NightlyStats.ini
;WRITEME process old DailyFinancial.csv data into NightlyStats.ini
;WRITEME generate Financial.csv from NightlyStats.ini (nightly script)
;WRITEME experiment with AHK_L
;WRITEME polish up lib_Email.ahk, add better error handling and put it on the forums
;WRITEME fix up OCR lib so that it works with AHK_L Unicode (I think it works)
;WRITEME make tests for OCR lib for AHK_L Unicode, and AHK_basic
;WRITEME make script that tests multiple sendmodes

;WRITEME ReceiveEmail lib (SendEmail, too)
;WRITEME maybe I should generate a static page of the AHK Benchmarks page when we get IronAHK to where it runs pretty well. we should also keep track of version numbers and output to a db or ini or csv file... html file should look like: http://www.autohotkey.net/~Uberi/Scripts/Benchmarks/Benchmarks%20Combined%20%28shajul%29.html
;WRITEME make a script that processes the code to see how far we are on each command... like this: http://www.ironahk.net/docs/developing/status/
;WRITEME might be nice to make a glossary of ahk terms (might include some CS terms)
;WRITEME make a widget sidebar in ahk... allow ability to add third-party widgets to the sidebar
;WRITEME add "currently working on this jira issue" to the widget
;WRITEME during git commit... remove unstaged changes and add all new files (maybe in one action)
;WRITEME automate this page: https://plus.google.com/u/0/notifications/circle
;WRITEME unit tests for RunIMacro()
;WRITEME monitor the dlb racing site to see if events are filling up
;WRITEME cpan4ahk ... a site that will give you links to all the pages of ahk libs and scripts
;WRITEME need to make a script that will parse the XMLdocs in IA and make nifty HTML pages out of them
;WRITEME make a nifty MP3 youtube downloader that will access snipmp3.com
;WRITEME macro for putting multiple scanned pages all into one PDF
;WRITEME NANY idea: screenshot sharing app that will let you quickly share a screenshot on imgin.it
;WRITEME bills reminder emailer
;WRITEME fix MonthlyDelta number generated by the ahk that approximates the maximum allowable credit card bill
;WRITEME figure out how to add an AHK service on boot... (currently in C:\Dropbox\batch-file-example.bat)
;WRITEME add AHK as a service using SC command
;WRITEME use wireshark with ahk to examine live captures (pipe it out to a file)
;WRITEME add a nice datestamp hotstring
;WRITEME need to make an ini stats lib
;WRITEME check if AHK compiles correctly
;WRITEME make CompileAHK use UseErrorLevel
;WRITEME make a nifty ahk sidebar
;WRITEME ahk sidebar widgets: Clock, Weather, CPU, RAM, Gmail... Other Crud: Stocks
;WRITEME save Baretail colors config from work computer to dropbox
;WRITEME exe/bat installers for git, ahk, ahk_L
;   if AHK is not installed, then auto-install (maybe... think before you do it)

;WRITEME make an instant diff tool (put it on the pastebin, prompt for part 2, put on pastebin)
;WRITEME make forums scraper that will pull information from each lib into a common format on a common ahk.net site (CPAN4AHK)
;WRITEME need to make a function that will run ahk code from a temp ahk file

;WRITEME change forum post for OCR lib to point to new release

;WRITEME FileDirGetModifiedDate() should show the newest modified date out of all the files in that folder
;WRITEME move files that are edited frequently and rapidly to the fastData folder

;WRITEME  FIXME fix auto git commit of AHKs folder
;WRITEME move morning status to fastData
;WRITEME make auto anonymouse only happen on work compy--not needed: blocks have been removed
;WRITEME DeleteConflictedCopies(folderPath, excludePath="")

;WRITEME copy event to my work gmail calendar
;WRITEME make event on my work gmail calendar
;WRITEME verify that this event does not need to be on my work gmail calendar

;WRITEME make AHK sidebar be able to force windows into sidebar

;FRIGGIN HECK WRITEME fix the dang nabbed github auto-upload on the home pc
;WRITEME unit tests for HATCHLING IRC
;WRITEME icon for hatchling IRC

;WRITEME allow "hidden" option while running iMacros (seems like this will be really hard to do) (entered at 2012-07-27_13-50-58)


;WRITEME make checking balance projection create a guess of what the credit bill will be using an average of the last few bills (entered at 2012-08-05_01-18-41)


;WRITEME automate freerice.com - just click at first (entered at 2012-10-05_19-35-17)
;WRITEME automate freerice - try to record answers and respond accordingly (entered at 2012-10-05_19-36-07)
;WRITEME terminate vsmon on home PC - process from the devil (entered at 2012-10-05_19-50-17)


;WRITEME delete exe files from github (also delete sugar* and lynx*) (entered at 2012-10-13_18-18-49)


;WRITEME    !callwhenever hotstring - insert schedule and say Definitely, give me a call at (888) 230-6874 x140 when you are ready. I have a meeting at 10:30-11:30 am, and another from 2-3pm, but other than that I should be available. (entered at 2012-10-31_17-38-41)


;WRITEME IA How-To (IronAHK) - then post it on the web (entered at 2012-11-01_15-44-31)


;WRITEME if vsmon.exe is taking up more than 30% cpu, then warn that virus scan is running in the widget (entered at 2012-11-03_15-39-36)


;WRITEME delete .swo and .swp files from C:\dropbox\ahks on startup (entered at 2012-11-12_18-51-49)