├── README.md
├── Remove2011
└── dockutil


/README.md:
--------------------------------------------------------------------------------
1 | # Remove2011
2 | <b>Microsoft Office 2011 for Mac Removal Tool</b>
3 | 
4 | Purpose: Removes Office 2011 for Mac from a computer (without breaking Office 2016 for Mac)</br>
5 | Usage: `Remove2011 [--Force] [--Help] [--KeepLync] [--SaveLicense]`</br>
6 | Use `--Force` to bypass warnings and forcibly remove Office 2011 applications and data</br>
7 | 


--------------------------------------------------------------------------------
/Remove2011:
--------------------------------------------------------------------------------
  1 | #!/bin/sh
  2 | #set -x
  3 | 
  4 | TOOL_NAME="Microsoft Office 2011 for Mac Removal Tool"
  5 | TOOL_VERSION="1.6"
  6 | 
  7 | ## Copyright (c) 2019 Microsoft Corp. All rights reserved.
  8 | ## Scripts are not supported under any Microsoft standard support program or service. The scripts are provided AS IS without warranty of any kind.
  9 | ## Microsoft disclaims all implied warranties including, without limitation, any implied warranties of merchantability or of fitness for a 
 10 | ## particular purpose. The entire risk arising out of the use or performance of the scripts and documentation remains with you. In no event shall
 11 | ## Microsoft, its authors, or anyone else involved in the creation, production, or delivery of the scripts be liable for any damages whatsoever 
 12 | ## (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary 
 13 | ## loss) arising out of the use of or inability to use the sample scripts or documentation, even if Microsoft has been advised of the possibility
 14 | ## of such damages.
 15 | 
 16 | ## Set up logging
 17 | # All stdout and sterr will go to the log file. Console alone can be accessed through >&3. For console and log use | tee /dev/fd/3
 18 | SCRIPT_NAME=$(basename "$0")
 19 | WORKING_FOLDER=$(dirname "$0")
 20 | LOG_FILE="$TMPDIR""$SCRIPT_NAME.log"
 21 | touch "$LOG_FILE"
 22 | exec 3>&1 1>>${LOG_FILE} 2>&1
 23 | 
 24 | ## Formatting support
 25 | TEXT_RED='\033[0;31m'
 26 | TEXT_YELLOW='\033[0;33m'
 27 | TEXT_GREEN='\033[0;32m'
 28 | TEXT_BLUE='\033[0;34m'
 29 | TEXT_NORMAL='\033[0m'
 30 | 
 31 | ## Initialize global variables
 32 | FORCE_PERM=false
 33 | PRESERVE_DATA=true
 34 | APP_RUNNING=false
 35 | KEEP_LYNC=false
 36 | SAVE_LICENSE=false
 37 | 
 38 | ## Path constants
 39 | PATH_OFFICE2011="/Applications/Microsoft Office 2011"
 40 | PATH_WORD2011="/Applications/Microsoft Office 2011/Microsoft Word.app"
 41 | PATH_EXCEL2011="/Applications/Microsoft Office 2011/Microsoft Excel.app"
 42 | PATH_PPT2011="/Applications/Microsoft Office 2011/Microsoft PowerPoint.app"
 43 | PATH_OUTLOOK2011="/Applications/Microsoft Office 2011/Microsoft Outlook.app"
 44 | PATH_LYNC2011="/Applications/Microsoft Lync.app"
 45 | PATH_MAU="/Library/Application Support/Microsoft/MAU2.0/Microsoft AutoUpdate.app"
 46 | 
 47 | ## Functions
 48 | function LogMessage {
 49 | 	echo $(date) "$*"
 50 | }
 51 | 
 52 | function ConsoleMessage {
 53 | 	echo "$*" >&3
 54 | }
 55 | 
 56 | function FormattedConsoleMessage {
 57 | 	FUNCDENT="$1"
 58 | 	FUNCTEXT="$2"
 59 | 	printf "$FUNCDENT" "$FUNCTEXT" >&3
 60 | }
 61 | 
 62 | function AllMessage {
 63 | 	echo $(date) "$*"
 64 | 	echo "$*" >&3
 65 | }
 66 | 
 67 | function LogDevice {
 68 | 	LogMessage "In function 'LogDevice'"
 69 | 	system_profiler SPSoftwareDataType -detailLevel mini
 70 | 	system_profiler SPHardwareDataType -detailLevel mini
 71 | }
 72 | 
 73 | function ShowUsage {
 74 | 	LogMessage "In function 'ShowUsage'"
 75 | 	ConsoleMessage "Usage: $SCRIPT_NAME [--Force] [--Help] [--KeepLync] [--SaveLicense]"
 76 | 	ConsoleMessage "Use --Force to bypass warnings and forcibly remove Office 2011 applications and data"
 77 | 	ConsoleMessage ""
 78 | }
 79 | 
 80 | function GetDestructivePerm {
 81 | 	LogMessage "In function 'GetDestructivePerm'"
 82 | 	if [ $FORCE_PERM = false ]; then
 83 | 		LogMessage "Script is not running with force - asking user for permission to continue"
 84 | 		ConsoleMessage "${TEXT_RED}WARNING: This procedure will remove application and data files.${TEXT_NORMAL}"
 85 | 		ConsoleMessage "${TEXT_RED}Be sure to have a backup before continuing.${TEXT_NORMAL}"
 86 | 		ConsoleMessage "Do you wish to continue? (y/n)"
 87 | 		read -p "" "GOAHEAD"
 88 | 		if [ "$GOAHEAD" == "y" ] || [ "$GOAHEAD" == "Y" ]; then
 89 | 			LogMessage "Destructive permissions granted by user"
 90 | 			return
 91 | 		else
 92 | 			LogMessage "Destructive permissions DENIED by user"
 93 | 			ConsoleMessage ""
 94 | 			exit 0
 95 | 		fi
 96 | 	fi
 97 | }
 98 | 
 99 | function GetDestructiveDataPerm {
100 | 	LogMessage "In function 'GetDestructiveDataPerm'"
101 | 	if [ $FORCE_PERM = false ]; then
102 | 		LogMessage "Script is not running with force - asking user for permission to remove data files"
103 | 		ConsoleMessage "${TEXT_RED}This tool can either preserve or remove Outlook data files.${TEXT_NORMAL}"
104 | 		ConsoleMessage "Do you wish to preserve Outlook data? (y/n)"
105 | 		read -p "" "GOAHEAD"
106 | 		if [ "$GOAHEAD" == "y" ] || [ "$GOAHEAD" == "Y" ]; then
107 | 			LogMessage "User chose to preserve Outlook data"
108 | 			PRESERVE_DATA=true
109 | 		else
110 | 			LogMessage "User chose to remove Outlook data"
111 | 			PRESERVE_DATA=false
112 | 		fi
113 | 	fi
114 | }
115 | 
116 | function GetDestructiveLicensePerm {
117 | 	LogMessage "In function 'GetDestructiveLicensePerm'"
118 | 	if [ $FORCE_PERM = false ]; then
119 | 		LogMessage "Script is not running with force - asking user for permission to remove license file"
120 | 		if [ $SAVE_LICENSE = false ]; then
121 | 			LogMessage "SAVE_LICENSE is false - asking user if they want to remove it"
122 | 			ConsoleMessage "${TEXT_RED}This tool can either preserve or remove your product activation license.${TEXT_NORMAL}"
123 | 			ConsoleMessage "Do you wish to preserve the license? (y/n)"
124 | 			read -p "" "GOAHEAD"
125 | 			if [ "$GOAHEAD" == "y" ] || [ "$GOAHEAD" == "Y" ]; then
126 | 				LogMessage "User chose to preserve the license"
127 | 				SAVE_LICENSE=true
128 | 			else
129 | 				LogMessage "User chose to remove the license"
130 | 				SAVE_LICENSE=false
131 | 			fi
132 | 		fi
133 | 	fi
134 | }
135 | function GetSudo {
136 | 	LogMessage "In function 'GetSudo'"
137 | 	if [ "$EUID" != "0" ]; then
138 | 		LogMessage "Script is not running as root - asking user for admin password"
139 | 		sudo -p "Enter administrator password: " echo
140 | 		if [ $? -eq 0 ] ; then
141 | 			LogMessage "Admin password entered successfully"
142 | 			ConsoleMessage ""
143 | 			return
144 | 		else
145 | 			LogMessage "Admin password is INCORRECT"
146 | 			exit 1
147 | 		fi
148 | 	fi
149 | }
150 | 
151 | function CheckRunning {
152 | 	FUNCPROC="$1"
153 | 	LogMessage "In function 'CheckRunning' with argument $FUNCPROC"
154 | 	local RUNNING_RESULT=$(ps ax | grep -v grep | grep "$FUNCPROC")
155 | 	if [ "${#RUNNING_RESULT}" -gt 0 ]; then
156 | 		LogMessage "$FUNCPROC is currently running"
157 | 		APP_RUNNING=true
158 | 	fi
159 | }
160 | 
161 | function CheckRunning2011 {
162 | 	LogMessage "In function 'CheckRunning2011'"
163 | 	CheckRunning "$PATH_WORD2011" "Word 2011"
164 | 	CheckRunning "$PATH_EXCEL2011" "Excel 2011"
165 | 	CheckRunning "$PATH_PPT2011" "PowerPoint 2011"
166 | 	CheckRunning "$PATH_OUTLOOK2011" "Outlook 2011"
167 | 	if [ $KEEP_LYNC = false ]; then 
168 | 		CheckRunning "$PATH_LYNC2011" "Lync 2011"
169 | 	fi
170 | }
171 | 
172 | function Close2011 {
173 | 	LogMessage "In function 'Close2011'"
174 | 	if [ $FORCE_PERM = false ]; then
175 | 		LogMessage "Script is not running with force - asking user for permission to continue"
176 | 		GetForcePerms
177 | 	fi
178 | 	ForceQuit2011
179 | }
180 | 
181 | function GetForcePerms {
182 | 	LogMessage "In function 'GetForcePerms'"
183 | 	ConsoleMessage "${TEXT_YELLOW}WARNING: Office applications are currently open and need to be closed.${TEXT_NORMAL}"
184 | 	ConsoleMessage "Do you want this program to forcibly close open applications? (y/n)"
185 | 	read -p "" "GOAHEAD"
186 | 	if [ "$GOAHEAD" == "y" ] || [ "$GOAHEAD" == "Y" ]; then
187 | 		LogMessage "User gave permission for the script to close running apps"
188 | 		FORCE_PERM=true
189 | 		ConsoleMessage ""
190 | 	else
191 | 		LogMessage "User DENIED permissions for the script to close running apps"
192 | 		ConsoleMessage ""
193 | 		exit 0
194 | 	fi
195 | }
196 | 
197 | function ForceTerminate {
198 | 	FUNCPROC="$1"
199 | 	LogMessage "In function 'ForceTerminate' with argument $FUNCPROC"
200 | 	$(ps ax | grep -v grep | grep "$FUNCPROC" | cut -d' ' -f1 | xargs kill -9 2> /dev/null)
201 | }
202 | 
203 | function ForceQuit2011 {
204 | 	LogMessage "In function 'ForceQuit2011'"
205 | 	FormattedConsoleMessage "%-55s" "Shutting down all Office 2011 applications"
206 | 	ForceTerminate "$PATH_WORD2011" "Word 2011"
207 | 	ForceTerminate "$PATH_EXCEL2011" "Excel 2011"
208 | 	ForceTerminate "$PATH_PPT2011" "PowerPoint 2011"
209 | 	ForceTerminate "$PATH_OUTLOOK2011" "Outlook 2011"
210 | 	if [ $KEEP_LYNC = false ]; then 
211 | 		ForceTerminate "$PATH_LYNC2011" "Lync 2011"
212 | 	fi
213 | 	ConsoleMessage "${TEXT_GREEN}Success${TEXT_NORMAL}"
214 | }
215 | 
216 | function RemoveComponent {
217 | 	FUNCPATH="$1"
218 | 	FUNCTEXT="$2"
219 | 	LogMessage "In function 'RemoveComponent with arguments $FUNCPATH and $FUNCTEXT'"
220 | 	FormattedConsoleMessage "%-55s" "Removing $FUNCTEXT"
221 | 	if [ -d "$FUNCPATH" ] || [ -e "$FUNCPATH" ] ; then
222 | 		LogMessage "Removing path $FUNCPATH"
223 | 		$(sudo rm -r -f "$FUNCPATH")
224 | 	else
225 | 		LogMessage "$FUNCPATH was not detected"
226 | 		ConsoleMessage "${TEXT_YELLOW}Not detected${TEXT_NORMAL}"
227 | 		return
228 | 	fi
229 | 	if [ -d "$FUNCPATH" ] || [ -e "$FUNCPATH" ] ; then
230 | 		LogMessage "Path $FUNCPATH still exists after deletion"
231 | 		ConsoleMessage "${TEXT_RED}Failed${TEXT_NORMAL}"
232 | 	else
233 | 		LogMessage "Path $FUNCPATH was successfully removed"
234 | 		ConsoleMessage "${TEXT_GREEN}Success${TEXT_NORMAL}"
235 | 	fi
236 | }
237 | 
238 | function RemoveUserComponent {
239 | 	FUNCPATH="$1"
240 | 	FUNCTEXT="$2"
241 | 	LogMessage "In function 'RemoveUserComponent with arguments $FUNCPATH and $FUNCTEXT'"
242 | 	for u in `ls /Users`; do
243 | 		FULLPATH="/Users/$u/$FUNCPATH"
244 | 		$(sudo rm -r -f $FULLPATH)
245 | 	done
246 | }
247 | 
248 | function PreserveUserComponent {
249 | 	FUNCPATH="$1"
250 | 	FUNCTEXT="$2"
251 | 	LogMessage "In function 'remove_PreserveComponent with arguments $FUNCPATH and $FUNCTEXT'"
252 | 	FormattedConsoleMessage "%-55s" "Preserving $FUNCTEXT"
253 | 	for u in `ls /Users`; do
254 | 		FULLPATH="/Users/$u/$FUNCPATH"
255 | 		if [ -d "$FULLPATH" ] || [ -e "$FULLPATH" ] ; then
256 | 			LogMessage "Renaming path $FULLPATH"
257 | 			$(sudo mv -fv "$FULLPATH" "$FULLPATH-Preserved")
258 | 		fi
259 | 	done
260 | 	ConsoleMessage "${TEXT_GREEN}Success${TEXT_NORMAL}"
261 | }
262 | 
263 | function Remove2011Receipts {
264 | 	LogMessage "In function 'Remove2011Receipts'"
265 | 	FormattedConsoleMessage "%-55s" "Removing Package Receipts. This can take several minutes"
266 | 	RECEIPTCOUNT=0
267 | 	RemoveReceipt "com.microsoft.office.all.*"
268 | 	RemoveReceipt "com.microsoft.office.en.*"
269 | 	RemoveReceipt "com.microsoft.merp.*"
270 | 	RemoveReceipt "com.microsoft.mau.*"
271 | 	if (( $RECEIPTCOUNT > 0 )) ; then
272 | 		ConsoleMessage "${TEXT_GREEN}Success${TEXT_NORMAL}"
273 | 	else
274 | 		ConsoleMessage "${TEXT_YELLOW}Not detected${TEXT_NORMAL}"
275 | 	fi
276 | }
277 | 
278 | function RemoveReceipt {
279 | 	FUNCPATH="$1"
280 | 	LogMessage "In function 'RemoveReceipt' with argument $FUNCPATH"
281 | 	PKGARRAY=($(pkgutil --pkgs=$FUNCPATH))
282 | 	for p in "${PKGARRAY[@]}"
283 | 	do
284 | 		LogMessage "Forgetting package $p"
285 | 		sudo pkgutil --forget $p
286 | 		if [ $? -eq 0 ] ; then
287 | 			((RECEIPTCOUNT++))
288 | 		fi
289 | 	done
290 | }
291 | 
292 | function Remove2011Preferences {
293 | 	LogMessage "In function 'Remove2011Preferences'"
294 | 	FormattedConsoleMessage "%-55s" "Removing Preferences"
295 | 	PREFCOUNT=0
296 | 	RemovePref "/Library/Preferences/com.microsoft.Word.plist"
297 | 	RemovePref "/Library/Preferences/com.microsoft.Excel.plist"
298 | 	RemovePref "/Library/Preferences/com.microsoft.Powerpoint.plist"
299 | 	RemovePref "/Library/Preferences/com.microsoft.Outlook.plist"
300 | 	RemovePref "/Library/Preferences/com.microsoft.outlook.databasedaemon.plist"
301 | 	RemovePref "/Library/Preferences/com.microsoft.DocumentConnection.plist"
302 | 	RemovePref "/Library/Preferences/com.microsoft.office.setupassistant.plist"
303 | 	RemoveUserPref "Library/Preferences/com.microsoft.Word.plist"
304 | 	RemoveUserPref "Library/Preferences/com.microsoft.Excel.plist"
305 | 	RemoveUserPref "Library/Preferences/com.microsoft.Powerpoint.plist"
306 | 	if [ $KEEP_LYNC = false ]; then 
307 | 		RemoveUserPref "Library/Preferences/com.microsoft.Lync.plist"
308 | 	fi
309 | 	RemoveUserPref "Library/Preferences/com.microsoft.Outlook.plist"
310 | 	RemoveUserPref "Library/Preferences/com.microsoft.outlook.databasedaemon.plist"
311 | 	RemoveUserPref "Library/Preferences/com.microsoft.outlook.office_reminders.plist"
312 | 	RemoveUserPref "Library/Preferences/com.microsoft.DocumentConnection.plist"
313 | 	RemoveUserPref "Library/Preferences/com.microsoft.office.setupassistant.plist"
314 | 	RemoveUserPref "Library/Preferences/com.microsoft.office.plist"
315 | 	RemoveUserPref "Library/Preferences/com.microsoft.error_reporting.plist"
316 | 	RemoveUserPref "Library/Preferences/ByHost/com.microsoft.Word.*.plist"
317 | 	RemoveUserPref "Library/Preferences/ByHost/com.microsoft.Excel.*.plist"
318 | 	RemoveUserPref "Library/Preferences/ByHost/com.microsoft.Powerpoint.*.plist"
319 | 	RemoveUserPref "Library/Preferences/ByHost/com.microsoft.Outlook.*.plist"
320 | 	RemoveUserPref "Library/Preferences/ByHost/com.microsoft.outlook.databasedaemon.*.plist"
321 | 	RemoveUserPref "Library/Preferences/ByHost/com.microsoft.DocumentConnection.*.plist"
322 | 	RemoveUserPref "Library/Preferences/ByHost/com.microsoft.office.setupassistant.*.plist"
323 | 	RemoveUserPref "Library/Preferences/ByHost/com.microsoft.registrationDB.*.plist"
324 | 	RemoveUserPref "Library/Preferences/ByHost/com.microsoft.e0Q*.*.plist"
325 | 	RemoveUserPref "Library/Preferences/ByHost/com.microsoft.Office365.*.plist"
326 | 	if [ $KEEP_LYNC = false ]; then 
327 | 		RemoveUserPref "Library/Preferences/ByHost/MicrosoftLyncRegistrationDB.*.plist"
328 | 	fi
329 | 	if (( $PREFCOUNT > 0 )); then
330 | 		ConsoleMessage "${TEXT_GREEN}Success${TEXT_NORMAL}"
331 | 	else
332 | 		ConsoleMessage "${TEXT_YELLOW}Not detected${TEXT_NORMAL}"
333 | 	fi
334 | }
335 | 
336 | function RemovePref {
337 | 	FUNCPATH="$1"
338 | 	LogMessage "In function 'RemovePref' with argument $FUNCPATH"
339 | 	ls $FUNCPATH
340 | 	if [ $? -eq 0 ] ; then
341 | 		LogMessage "Found preference $FUNCPATH"
342 | 		$(sudo rm -f $FUNCPATH)
343 | 		if [ $? -eq 0 ] ; then
344 | 			LogMessage "Preference $FUNCPATH removed"
345 | 			((PREFCOUNT++))
346 | 		else
347 | 			LogMessage "Preference $FUNCPATH could NOT be removed"
348 | 		fi
349 | 	fi
350 | }
351 | 
352 | function RemoveUserPref {
353 | 	FUNCPATH="$1"
354 | 	LogMessage "In function 'RemoveUserPref' with argument $FUNCPATH"
355 | 	for u in `ls /Users`; do
356 | 		FULLPATH="/Users/$u/$FUNCPATH"
357 | 		$(sudo rm -f $FULLPATH)
358 | 		((PREFCOUNT++))
359 | 	done
360 | }
361 | 
362 | function CleanDock {
363 | 	LogMessage "In function 'CleanDock'"
364 | 	FormattedConsoleMessage "%-55s" "Cleaning icons in dock"
365 | 	if [ -e "$WORKING_FOLDER/dockutil" ]; then
366 | 		LogMessage "Found DockUtil tool"
367 | 		sudo "$WORKING_FOLDER"/dockutil --remove "file:///Applications/Microsoft%20Office%202011/Microsoft%20Document%20Connection.app/" --no-restart
368 | 		sudo "$WORKING_FOLDER"/dockutil --remove "file:///Applications/Microsoft%20Office%202011/Microsoft%20Word.app/" --no-restart
369 | 		sudo "$WORKING_FOLDER"/dockutil --remove "file:///Applications/Microsoft%20Office%202011/Microsoft%20Excel.app/" --no-restart
370 | 		sudo "$WORKING_FOLDER"/dockutil --remove "file:///Applications/Microsoft%20Office%202011/Microsoft%20PowerPoint.app/" --no-restart
371 | 		if [ $KEEP_LYNC = false ]; then 
372 | 			sudo "$WORKING_FOLDER"/dockutil --remove "file:///Applications/Microsoft%20Office%202011/Microsoft%20Lync.app/" --no-restart
373 | 		fi
374 | 		sudo "$WORKING_FOLDER"/dockutil --remove "file:///Applications/Microsoft%20Office%202011/Microsoft%20Outlook.app/"
375 | 		LogMessage "Completed dock clean-up"
376 | 		ConsoleMessage "${TEXT_GREEN}Success${TEXT_NORMAL}"
377 | 	else
378 | 		ConsoleMessage "${TEXT_YELLOW}Not detected${TEXT_NORMAL}"
379 | 	fi
380 | }
381 | 
382 | function RelaunchCFPrefs {
383 | 	LogMessage "In function 'RelaunchCFPrefs'"
384 | 	FormattedConsoleMessage "%-55s" "Restarting Preferences Daemon"
385 | 	sudo ps ax | grep -v grep | grep "cfprefsd" | cut -d' ' -f1 | xargs sudo kill -9
386 | 	if [ $? -eq 0 ] ; then
387 | 		LogMessage "Successfully terminated all preferences daemons"
388 | 		ConsoleMessage "${TEXT_GREEN}Success${TEXT_NORMAL}"
389 | 	else
390 | 		LogMessage "FAILED to terminate all preferences daemons"
391 | 		ConsoleMessage "${TEXT_RED}Failed${TEXT_NORMAL}"
392 | 	fi
393 | }
394 | 
395 | function MainLoop {
396 | 	LogMessage "In function 'MainLoop'"
397 | 	# Show warning about destructive behavior of the script and ask for permission to continue
398 | 	GetDestructivePerm
399 | 	GetDestructiveDataPerm
400 | 	GetDestructiveLicensePerm
401 | 	# If appropriate, elevate permissions so the script can perform all actions
402 | 	GetSudo
403 | 	# Check to see if any of the 2011 apps are currently open
404 | 	CheckRunning2011
405 | 	if [ $APP_RUNNING = true ]; then
406 | 		LogMessage "One of more 2011 apps are running"
407 | 		Close2011
408 | 	fi
409 | 	# Remove Office 2011 apps
410 | 	RemoveComponent "$PATH_OFFICE2011" "Office 2011 Applications"
411 | 	if [ $KEEP_LYNC = false ]; then 
412 | 		RemoveComponent "$PATH_LYNC2011" "Lync"
413 | 	fi
414 | 	
415 | 	# Remove Office 2011 helpers
416 | 	RemoveComponent "/Library/LaunchDaemons/com.microsoft.office.licensing.helper.plist" "Launch Daemon: Licensing Helper"
417 | 	RemoveComponent "/Library/PrivilegedHelperTools/com.microsoft.office.licensing.helper" "Helper Tools: Licensing Helper"
418 | 	# Remove Office 2011 fonts
419 | 	RemoveComponent "/Library/Fonts/Microsoft" "Office Fonts"
420 | 	# Remove Office 2011 license
421 | 	if [ $SAVE_LICENSE = false ]; then
422 | 		LogMessage "SAVE_LICENSE is false - removing license file"
423 | 		RemoveComponent "/Library/Preferences/com.microsoft.office.licensing.plist" "Product License"
424 | 	fi
425 | 	# Remove Office 2011 application support
426 | 	RemoveComponent "/Library/Application Support/Microsoft/MERP2.0" "Error Reporting"
427 | 	RemoveComponent "/Library/Application Support/Microsoft/HV1.0" "Help Viewer"
428 | 	RemoveComponent "/Library/Application Support/Microsoft/Office Converter Support" "Converter Support"
429 | 	RemoveComponent "/Library/Application Support/Microsoft/Silverlight" "Silverlight"
430 | 	RemoveComponent "/Applications/Remote Desktop Connection.app" "Remote Desktop Connection"
431 | 	RemoveUserComponent "Library/Application Support/Microsoft/Office" "Application Support"
432 | 	# Remove Office 2011 caches
433 | 	RemoveUserComponent "Library/Caches/com.microsoft.browserfont.cache" "Browser Font Cache"
434 | 	RemoveUserComponent "Library/Caches/com.microsoft.office.setupassistant" "Setup Assistant Cache"
435 | 	RemoveUserComponent "Library/Caches/Microsoft/Office" "Office Cache"
436 | 	RemoveUserComponent "Library/Caches/Outlook" "Outlook Identity Cache"
437 | 	RemoveUserComponent "Library/Caches/com.microsoft.Outlook" "Outlook Cache"
438 | 	# Remove Office 2011 preferences
439 | 	Remove2011Preferences
440 | 	# Remove or rename Outlook 2011 identities and databases
441 | 	if [ $PRESERVE_DATA = false ]; then
442 | 		RemoveUserComponent "Documents/Microsoft User Data/Office 2011 Identities" "Outlook Identities and Databases"
443 | 		RemoveUserComponent "Documents/Microsoft User Data/Saved Attachments" "Outlook Saved Attachments"
444 | 		RemoveUserComponent "Documents/Microsoft User Data/Outlook Sound Sets" "Outlook Sound Sets"
445 | 	else
446 | 		PreserveUserComponent "Documents/Microsoft User Data/Office 2011 Identities" "Outlook Identities and Databases"
447 | 		PreserveUserComponent "Documents/Microsoft User Data/Saved Attachments" "Outlook Saved Attachments"
448 | 		PreserveUserComponent "Documents/Microsoft User Data/Outlook Sound Sets" "Outlook Sound Sets"
449 | 	fi
450 | 	# Remove Office 2011 package receipts
451 | 	Remove2011Receipts
452 | 	# Clean up icons on the dock
453 | 	CleanDock
454 | 	# Restart cfprefs
455 | 	RelaunchCFPrefs
456 | }
457 | 
458 | ## Main
459 | LogMessage "Starting $SCRIPT_NAME"
460 | AllMessage "${TEXT_BLUE}=== $TOOL_NAME $TOOL_VERSION ===${TEXT_NORMAL}"
461 | LogDevice
462 | 
463 | # Evaluate command-line arguments
464 | if [[ $# = 0 ]]; then
465 | 	LogMessage "No command-line arguments passed, going into interactive mode"
466 | 	MainLoop
467 | else
468 | 	LogMessage "Command-line arguments passed, attempting to parse"
469 | 	while [[ $# > 0 ]]
470 | 	do
471 | 	key="$1"
472 | 	LogMessage "Argument: $key"
473 | 	case "$key" in
474 |     	--Help|-h|--help)
475 |     	ShowUsage
476 |     	exit 0
477 | 	shift # past argument
478 |     	;;
479 |     	--Force|-f|--force)
480 |     	LogMessage "Force mode set to TRUE"
481 |     	FORCE_PERM=true
482 |     	shift # past argument
483 |     	;;
484 |     	--KeepLync|-k|--keeplync)
485 |     	LogMessage "Keep Lync set to TRUE"
486 |     	KEEP_LYNC=true
487 |     	shift # past argument
488 |     	;;
489 |     	--SaveLicense|-s|--savelicense)
490 |     	LogMessage "SaveLicense set to TRUE"
491 |     	SAVE_LICENSE=true
492 |     	shift # past argument
493 |     	;;
494 |     	*)
495 |     	ShowUsage
496 |     	echo "Ignoring unrecognized argument: $key"
497 |     	;;
498 | 	esac
499 | 	shift # past argument or value
500 | 	done
501 | 	MainLoop
502 | fi
503 | 
504 | ConsoleMessage ""
505 | ConsoleMessage "All events and errors were logged to $LOG_FILE"
506 | ConsoleMessage ""
507 | LogMessage "Exiting script"
508 | exit 0
509 | 


--------------------------------------------------------------------------------
/dockutil:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/python
  2 | 
  3 | #   This file is based on or incorporates material from the projects listed below (Third Party IP). The original copyright notice and the license under
  4 | #   which Microsoft received such Third Party IP, are set forth below. Such licenses and notices are provided for informational purposes only. Microsoft
  5 | #   licenses the Third Party IP to you under the licensing terms for the Microsoft product. Microsoft reserves all other rights not expressly granted 
  6 | #   under this agreement, whether by implication, estoppel or otherwise.
  7 | 
  8 | #   DOCKUTIL
  9 | #   Copyright 2008 Kyle Crawford
 10 | 
 11 | #   Provided for Informational Purposes Only 
 12 | 
 13 | #   Licensed under the Apache License, Version 2.0 (the "License");
 14 | #   you may not use this file except in compliance with the License.
 15 | #   You may obtain a copy of the License at
 16 | #
 17 | #   http://www.apache.org/licenses/LICENSE-2.0
 18 | 
 19 | #   THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY
 20 | #   IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT.
 21 | 
 22 | #   See the Apache Version 2.0 License for specific language governing permissions and limitations under the License.
 23 | 
 24 | #   Send bug reports and comments to kcrwfrd at gmail
 25 | 
 26 | # Possible future enhancements
 27 | # tie in with application identifier codes for locating apps and replacing them in the dock with newer versions?
 28 | 
 29 | import sys, plistlib, subprocess, os, getopt, re, pipes, tempfile, pwd
 30 | import platform
 31 | 
 32 | 
 33 | # default verbose printing to off
 34 | verbose = False
 35 | version = '2.0.2'
 36 | 
 37 | def usage(e=None):
 38 |     """Displays usage information and error if one occurred"""
 39 | 
 40 |     print """usage:     %(progname)s -h
 41 | usage:     %(progname)s --add <path to item> | <url> [--label <label>] [ folder_options ] [ position_options ] [ plist_location_specification ] [--no-restart]
 42 | usage:     %(progname)s --remove <dock item label> | all [ plist_location_specification ] [--no-restart]
 43 | usage:     %(progname)s --move <dock item label>  position_options [ plist_location_specification ]
 44 | usage:     %(progname)s --find <dock item label> [ plist_location_specification ]
 45 | usage:     %(progname)s --list [ plist_location_specification ]
 46 | usage:     %(progname)s --version
 47 | 
 48 | position_options:
 49 |   --replacing <dock item label name>                            replaces the item with the given dock label or adds the item to the end if item to replace is not found
 50 |   --position [ index_number | beginning | end | middle ]        inserts the item at a fixed position: can be an position by index number or keyword
 51 |   --after <dock item label name>                                inserts the item immediately after the given dock label or at the end if the item is not found
 52 |   --before <dock item label name>                               inserts the item immediately before the given dock label or at the end if the item is not found
 53 |   --section [ apps | others ]                                   specifies whether the item should be added to the apps or others section
 54 | 
 55 | plist_location_specifications:
 56 |   <path to a specific plist>                                    default is the dock plist for current user
 57 |   <path to a home directory>
 58 |   --allhomes                                                    attempts to locate all home directories and perform the operation on each of them
 59 |   --homeloc                                                     overrides the default /Users location for home directories
 60 | 
 61 | folder_options:
 62 |   --view [grid|fan|list|automatic]                              stack view option
 63 |   --display [folder|stack]                                      how to display a folder's icon
 64 |   --sort [name|dateadded|datemodified|datecreated|kind]         sets sorting option for a folder view
 65 | 
 66 | Examples:
 67 |   The following adds TextEdit.app to the end of the current user's dock:
 68 |            %(progname)s --add /Applications/TextEdit.app
 69 | 
 70 |   The following replaces Time Machine with TextEdit.app in the current user's dock:
 71 |            %(progname)s --add /Applications/TextEdit.app --replacing 'Time Machine'
 72 | 
 73 |   The following adds TextEdit.app after the item Time Machine in every user's dock on that machine:
 74 |            %(progname)s --add /Applications/TextEdit.app --after 'Time Machine' --allhomes
 75 | 
 76 |   The following adds ~/Downloads as a grid stack displayed as a folder for every user's dock on that machine:
 77 |            %(progname)s --add '~/Downloads' --view grid --display folder --allhomes
 78 | 
 79 |   The following adds a url dock item after the Downloads dock item for every user's dock on that machine:
 80 |            %(progname)s --add vnc://miniserver.local --label 'Mini VNC' --after Downloads --allhomes
 81 | 
 82 |   The following removes System Preferences from every user's dock on that machine:
 83 |            %(progname)s --remove 'System Preferences' --allhomes
 84 | 
 85 |   The following moves System Preferences to the second slot on every user's dock on that machine:
 86 |            %(progname)s --move 'System Preferences' --position 2 --allhomes
 87 | 
 88 |   The following finds any instance of iTunes in the specified home directory's dock:
 89 |            %(progname)s --find iTunes /Users/jsmith
 90 | 
 91 |   The following lists all dock items for all home directories at homeloc in the form: item<tab>path<tab><section>tab<plist>
 92 |            %(progname)s --list --homeloc /Volumes/RAID/Homes --allhomes
 93 | 
 94 |   The following adds Firefox after Safari in the Default User Template without restarting the Dock
 95 |            %(progname)s --add /Applications/Firefox.app --after Safari --no-restart '/System/Library/User Template/English.lproj'
 96 | 
 97 | 
 98 | Notes:
 99 |   When specifying a relative path like ~/Documents with the --allhomes option, ~/Documents must be quoted like '~/Documents' to get the item relative to each home
100 | 
101 | Bugs:
102 |   Names containing special characters like accent marks will fail
103 | 
104 | 
105 | Contact:
106 |   Send bug reports and comments to kcrwfrd at gmail.
107 | """ % dict(progname = os.path.basename(sys.argv[0]))
108 |     if e:
109 |         print ""
110 |         print 'Error processing options:', e
111 |         sys.exit(1)
112 |     sys.exit(0)
113 | 
114 | def verboseOutput(*args):
115 |     """Used by verbose option (-v) to send more output to stdout"""
116 |     if verbose:
117 |         try:
118 |             print "verbose:", args
119 |         except:
120 |             pass
121 | 
122 | def main():
123 |     """Parses options and arguments and performs fuctions"""
124 |     # setup our getoput opts and args
125 |     try:
126 |         (optargs, args) = getopt.getopt(sys.argv[1:], 'hv', ["help", "version",
127 |             "section=", "list", "find=", "add=", "move=", "replacing=",
128 |             "remove=", "after=", "before=", "position=", "display=", "view=",
129 |             "sort=", "label=", "type=", "allhomes", "homeloc=", "no-restart", "hupdock="])
130 |     except getopt.GetoptError, e:  # if parsing of options fails, display usage and parse error
131 |         usage(e)
132 | 
133 |     # setup default values
134 |     global verbose
135 |     add_path = None
136 |     remove_labels = []
137 |     find_label = None
138 |     move_label = None
139 |     after_item = None
140 |     before_item = None
141 |     position = None
142 |     add_path = None
143 |     plist_path = None
144 |     list = False
145 |     all_homes = False
146 |     replace_label = None
147 |     section = None
148 |     displayas = None
149 |     showas = None
150 |     arrangement = None
151 |     tile_type = None
152 |     label_name = None
153 |     home_directories_loc = '/Users'
154 |     restart_dock = True
155 | 
156 |     for opt, arg in optargs:
157 |         if opt in ("-h", "--help"):
158 |             usage()
159 |         elif opt == "-v":
160 |             verbose = True
161 |         elif opt == "--version":
162 |             print version
163 |             sys.exit(0)
164 |         elif opt == "--add":
165 |             add_path = arg
166 |         elif opt == "--replacing":
167 |             replace_label = arg
168 |         elif opt == "--move":
169 |             move_label = arg
170 |         elif opt == "--find":
171 |             find_label = arg
172 |         elif opt == "--remove":
173 |             remove_labels.append(arg)
174 |         elif opt == "--after":
175 |             after_item = arg
176 |         elif opt == "--before":
177 |             before_item = arg
178 |         elif opt == "--position":
179 |             position = arg
180 |         elif opt == "--label":
181 |             label_name = arg
182 |         elif opt == '--sort':
183 |             if arg == 'name':
184 |                 arrangement = 1
185 |             elif arg == 'dateadded':
186 |                 arrangement = 2
187 |             elif arg == 'datemodified':
188 |                 arrangement = 3
189 |             elif arg == 'datecreated':
190 |                 arrangement = 4
191 |             elif arg == 'kind':
192 |                 arrangement = 5
193 |             else:
194 |                 usage('unsupported --sort argument')
195 |         elif opt == '--view':
196 |             if arg == 'fan':
197 |                 showas = 1
198 |             elif arg == 'grid':
199 |                 showas = 2
200 |             elif arg == 'list':
201 |                 showas = 3
202 |             elif arg == 'auto':
203 |                 showas = 0
204 |             else:
205 |                 usage('unsupported --view argument')
206 |         elif opt == '--display':
207 |             if arg == 'stack':
208 |                 displayas = 0
209 |             elif arg == 'folder':
210 |                 displayas = 1
211 |             else:
212 |                 usage('unsupported --display argument')
213 |         elif opt == '--type':
214 |             tile_type = arg+'-tile'
215 |         elif opt == '--section':
216 |             section = 'persistent-'+arg
217 |         elif opt == '--list':
218 |             list = True
219 |         elif opt == '--allhomes':
220 |             all_homes = True
221 |         elif opt == '--homeloc':
222 |             home_directories_loc = arg
223 |         elif opt == '--no-restart':
224 |             restart_dock = False
225 | 
226 |         # for legacy compatibility only
227 |         elif opt == '--hupdock':
228 |             if arg.lower() in ("false", "no", "off", "0"):
229 |                 restart_dock = False
230 | 
231 |     # check for an action
232 |     if add_path == None and not remove_labels and move_label == None and find_label == None and list == False:
233 |         usage('no action was specified')
234 | 
235 | 
236 |     # get the list of plists to process
237 |     # if allhomes option was set, get a list of home directories in the homedirectory location
238 |     if all_homes:
239 |         possible_homes = os.listdir(home_directories_loc)
240 |         plist_paths = [ home_directories_loc+'/'+home+'/Library/Preferences/com.apple.dock.plist' for home in possible_homes if os.path.exists(home_directories_loc+'/'+home+'/Library/Preferences/com.apple.dock.plist') and os.path.exists(home_directories_loc+'/'+home+'/Desktop')]
241 |     else: # allhomes was not specified
242 |         # if no plist argument, then use the user's home directory dock plist, otherwise use the arguments provided
243 |         if args == []:
244 |             plist_paths = [ os.path.expanduser('~/Library/Preferences/com.apple.dock.plist') ]
245 |         else:
246 |             plist_paths = args
247 |     # exit if we couldn't find any plists to process
248 |     if len(plist_paths) < 1:
249 |         print 'no dock plists were found'
250 |         sys.exit(1)
251 | 
252 |     # loop over plist paths
253 |     for plist_path in plist_paths:
254 | 
255 |         verboseOutput('processing', plist_path)
256 |         # a home directory is allowed as an argument, so if the plist_path is a
257 |         # directory, we append the relative path to the plist
258 |         if os.path.isdir(plist_path):
259 |             plist_path = os.path.join(plist_path,'Library/Preferences/com.apple.dock.plist')
260 | 
261 |         # verify that the plist exists at the given path
262 |         # and expand and quote it for use when shelling out
263 |         if os.path.exists(os.path.expanduser(plist_path)):
264 |             plist_path = os.path.expanduser(plist_path)
265 |             plist_path = os.path.abspath(plist_path)
266 |             plist_path = pipes.quote(plist_path)
267 |         else:
268 |             print plist_path, 'does not seem to be a home directory or a dock plist'
269 |             sys.exit(1)
270 | 
271 | 
272 |         # check for each action and process accordingly
273 |         if remove_labels: # --remove action(s)
274 |             pl = readPlist(plist_path)
275 |             changed = False
276 |             for remove_label in remove_labels:
277 |                 if removeItem(pl, remove_label):
278 |                     changed = True
279 |                 else:
280 |                     print 'item', remove_label, 'was not found in', plist_path
281 |             if changed:
282 |                 commitPlist(pl, plist_path, restart_dock)
283 |         elif list: # --list action
284 |             pl = readPlist(plist_path)
285 |             # print a tab separated line for each item in the plist
286 |             # for each section
287 |             for section in ['persistent-apps', 'persistent-others']:
288 |                 # for item in section
289 |                 for item in pl[section]:
290 |                     try:
291 |                         # join and print relevant data into a string separated by tabs
292 |                         print '\t'.join((item['tile-data']['file-label'], item['tile-data']['file-data']['_CFURLString'], section, plist_path))
293 |                     except:
294 |                         pass
295 | 
296 |         elif find_label != None: # --find action
297 |             # since we are only reading the plist, make a copy before converting it to be read
298 |             pl = readPlist(plist_path)
299 |             # set found state
300 |             item_found = False
301 |             # loop through dock items looking for a match with provided find_label
302 |             for section in ['persistent-apps', 'persistent-others']:
303 |                 for item_offset in range(len(pl[section])):
304 |                     try:
305 |                         if pl[section][item_offset]['tile-data']['file-label'] == find_label:
306 |                             item_found = True
307 |                             print find_label, "was found in", section, "at slot", item_offset+1, "in", plist_path
308 |                     except:
309 |                         pass
310 |             if not item_found:
311 |                 print find_label, "was not found in", plist_path
312 |                 if not all_homes:  # only exit non-zero if we aren't processing all homes, because for allhomes, exit status for find would be irrelevant
313 |                     sys.exit(1)
314 | 
315 |         elif move_label != None: # --move action
316 |             pl = readPlist(plist_path)
317 |             # check for a position option before processing
318 |             if position is None and before_item is None and after_item is None:
319 |                 usage('move action requires a position destination')
320 |             # perform the move and save the plist if it was successful
321 |             if moveItem(pl, move_label, position, before_item, after_item):
322 |                 commitPlist(pl, plist_path, restart_dock)
323 |             else:
324 |                 print 'move failed for', move_label, 'in', plist_path
325 | 
326 |         elif add_path != None:  # --add action
327 |             if add_path.startswith('~'): # we've got a relative path and relative paths need to be processed by using a path relative to this home directory
328 |                 real_add_path = re.sub('^~', plist_path.replace('/Library/Preferences/com.apple.dock.plist',''), add_path) # swap out the full home path for the ~
329 |             else:
330 |                 real_add_path = add_path
331 |             # determine smart default values where possible
332 |             if section == None:
333 |                 if real_add_path.endswith('.app') or real_add_path.endswith('.app/'): # we've got an application
334 |                     section = 'persistent-apps'
335 |                 elif displayas != None or showas != None or arrangement != None: # we've got a folder
336 |                     section = 'persistent-others'
337 | 
338 |             if tile_type is None:  # if type was not specified, we try to figure that out using the filesystem
339 |                 if os.path.isdir(real_add_path) and section != 'persistent-apps': # app bundles are directories too
340 |                     tile_type = 'directory-tile'
341 |                 elif re.match('\w*://', real_add_path): # regex to determine a url in the form xyz://abcdef.adsf.com/adsf
342 |                     tile_type = 'url-tile'
343 |                     section = 'persistent-others'
344 |                 else:
345 |                     tile_type = 'file-tile'
346 | 
347 |             if section == None:
348 |                 section = 'persistent-others'
349 | 
350 | 
351 |             if tile_type != 'url-tile': # paths can't be relative in dock items
352 |                 real_add_path = os.path.realpath(real_add_path)
353 | 
354 | 
355 |             pl = readPlist(plist_path)
356 |             verboseOutput('adding', real_add_path)
357 |             # perform the add save the plist if it was successful
358 |             if addItem(pl, real_add_path, replace_label, position, before_item, after_item, section, displayas, showas, arrangement, tile_type, label_name):
359 |                 commitPlist(pl, plist_path, restart_dock)
360 |             else:
361 |                 print 'item', add_path, 'was not added to Dock'
362 |                 if not all_homes:  # only exit non-zero if we aren't processing all homes, because for allhomes, exit status for add would be irrelevant
363 |                     sys.exit(1)
364 | 
365 | # NOTE on use of defaults
366 | # We use defaults because it knows how to handle cfpreferences caching even when given a path rather than a domain
367 | # This allows us to keep using path-based plist specifications rather than domains
368 | # Preserving path based plists are important for people needing to run this on a non boot volume
369 | # However if Apple stops using plists or moves the plist path, all of this will break
370 | # So at that point we will have to change the API so users pass in a defaults domain or user rather than a plist path
371 | def writePlist(pl, plist_path):
372 |     """writes a plist object down to a file"""
373 |     # get the unescaped path
374 |     plist_path = path_as_string(plist_path)
375 |     # get a tempfile path for writing our plist
376 |     plist_import_path = tempfile.mktemp()
377 |     # Write the plist to our temporary plist for importing because defaults can't import from a pipe (yet)
378 |     plistlib.writePlist(pl, plist_import_path)
379 |     # get original permissions
380 |     plist_stat = os.stat(plist_path)
381 |     # If we are running as root, ensure we run as the correct user to update cfprefsd
382 |     if os.geteuid() == 0:
383 |         # Running defaults as the user only works if the user exists
384 |         if valid_uid(plist_stat.st_uid):
385 |             subprocess.Popen(['sudo', '-u', '#%d' % plist_stat.st_uid, '-g', '#%d' % plist_stat.st_gid, 'defaults', 'import', plist_path, plist_import_path])
386 |         else:
387 |             subprocess.Popen(['defaults', 'import', plist_path, plist_import_path])
388 |             os.chown(plist_path, plist_stat.st_uid, plist_stat.st_gid)
389 |             os.chmod(plist_path, plist_stat.st_mode)
390 |     else:
391 |         subprocess.Popen(['defaults', 'import', plist_path, plist_import_path])
392 | 
393 | 
394 | def valid_uid(uid):
395 |     """returns bool of whether uid can be resolved to a user"""
396 |     try:
397 |         pwd.getpwuid(uid)
398 |         return True
399 |     except:
400 |         return False
401 | 
402 | def getOsxVersion():
403 |     """returns a tuple with the (major,minor,revision) numbers"""
404 |     # OS X Yosemite return 10.10, so we will be happy with len(...) == 2, then add 0 for last number
405 |     try:
406 |         mac_ver = tuple(int(n) for n in platform.mac_ver()[0].split('.'))
407 |         assert 2 <= len(mac_ver) <= 3
408 |     except Exception as e:
409 |         raise e
410 |     if len(mac_ver) == 2:
411 |       mac_ver = mac_ver + (0, )
412 |     return mac_ver
413 | 
414 | def readPlist(plist_path):
415 |     """returns a plist object read from a file path"""
416 |     # get the unescaped path
417 |     plist_path = path_as_string(plist_path)
418 |     # get a tempfile path for exporting our defaults data
419 |     export_fifo = tempfile.mktemp()
420 |     # make a fifo for defaults export in a temp file
421 |     os.mkfifo(export_fifo)
422 |     # export to the fifo
423 |     osx_version = getOsxVersion()
424 |     if osx_version[1] >= 9:
425 |         subprocess.Popen(['defaults', 'export', plist_path, export_fifo]).communicate()
426 |         # convert the export to xml
427 |         plist_string = subprocess.Popen(['plutil', '-convert', 'xml1', export_fifo, '-o', '-'], stdout=subprocess.PIPE).stdout.read()
428 |     else:
429 |         try:
430 |             cmd = ['/usr/libexec/PlistBuddy','-x','-c', 'print',plist_path]
431 |             proc = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
432 |             (plist_string,err) = proc.communicate()
433 |         except Exception as e:
434 |             raise e
435 |     # parse the xml into a dictionary
436 |     pl = plistlib.readPlistFromString(plist_string)
437 |     return pl
438 | 
439 | def path_as_string(path):
440 |     """returns an unescaped string of the path"""
441 |     return subprocess.Popen('ls -d '+path, shell=True, stdout=subprocess.PIPE).stdout.read().rstrip('\n')
442 | 
443 | def moveItem(pl, move_label=None, position=None, before_item=None, after_item=None):
444 |     """locates an existing dock item and moves it to a new position"""
445 |     for section in ['persistent-apps', 'persistent-others']:
446 |         item_to_move = None
447 |         # loop over the items looking for the item label
448 |         for item_offset in range(len(pl[section])):
449 |             if pl[section][item_offset]['tile-data']['file-label'] == move_label:
450 |                 item_found = True
451 |                 verboseOutput('found', move_label) 
452 |                 # make a copy of the found dock entry
453 |                 item_to_move = pl[section][item_offset]
454 |                 found_offset = item_offset
455 |                 break
456 |             else:
457 |                 verboseOutput('no match for', pl[section][item_offset]['tile-data']['file-label'])
458 |         # if the item wasn't found, continue to next section loop iteration
459 |         if item_to_move == None:
460 |             continue
461 |         # we are still inside the section for loop
462 |         # remove the found item
463 |         pl[section].remove(pl[section][item_offset])
464 | 
465 |         # figure out where to re-insert the original dock item back into the plist
466 |         if position != None:
467 |             if position in [ 'beginning', 'begin', 'first' ]:        
468 |                 pl[section].insert(0, item_to_move)
469 |                 return True
470 |             elif position in [ 'end', 'last' ]:
471 |                 pl[section].append(item_to_move)
472 |                 return True
473 |             elif position in [ 'middle', 'center' ]:
474 |                 midpoint = int(len(pl[section])/2)
475 |                 pl[section].insert(midpoint, item_to_move)
476 |                 return True
477 |             else:
478 |                 # if the position integer starts with a + or - , then add or subtract from its current position respectively
479 |                 if position.startswith('-') or position.startswith('+'):
480 |                     new_position = int(position) + found_offset
481 |                     if new_position > len(pl[section]):
482 |                         pl[section].append(item_to_move)
483 |                     elif new_position < 0:
484 |                         pl[section].insert(0, item_to_move)
485 |                     else:
486 |                         pl[section].insert(int(position) + found_offset, item_to_move)
487 |                     return True
488 | 
489 |                 try:
490 |                     int(position)
491 |                 except:
492 |                     print 'Invalid position', position
493 |                     return False
494 |                 pl[section].insert(int(position)-1, item_to_move)
495 |                 return True
496 |         elif after_item != None or before_item != None:
497 |             # if after or before is set, find the offset of that item and do the insert relative to that offset
498 |             for item_offset in range(len(pl[section])):
499 |                 try:
500 |                     if after_item != None:
501 |                         if pl[section][item_offset]['tile-data']['file-label'] == after_item:
502 |                             pl[section].insert(item_offset+1, item_to_move)
503 |                             return True
504 |                     if before_item != None:
505 |                         if pl[section][item_offset]['tile-data']['file-label'] == before_item:
506 |                             pl[section].insert(item_offset, item_to_move)
507 |                             return True
508 |                 except KeyError:
509 |                     pass
510 | 
511 |     return False
512 | 
513 | def generate_guid():
514 |     """returns guid string"""
515 |     return subprocess.Popen(['/usr/bin/uuidgen'],stdout=subprocess.PIPE).communicate()[0].rstrip()
516 | 
517 | def addItem(pl, add_path, replace_label=None, position=None, before_item=None, after_item=None, section='persistent-apps', displayas=1, showas=1, arrangement=2, tile_type='file-tile',label_name=None):
518 |     """adds an item to an existing dock plist object"""
519 |     if displayas == None: displayas = 1
520 |     if showas == None: showas = 0
521 |     if arrangement == None: arrangement = 2
522 | 
523 |     #fix problems with unicode file names
524 |     enc = (sys.stdin.encoding if sys.stdin.encoding else 'UTF-8')
525 |     add_path = unicode(add_path, enc)
526 | 
527 |     # set a dock label if one isn't provided
528 |     if label_name == None:
529 |         if tile_type == 'url-tile':
530 |             label_name = add_path
531 |             section = 'persistent-others'
532 |         else:
533 |             base_name = re.sub('/$', '', add_path).split('/')[-1]
534 |             label_name = re.sub('.app$', '', base_name)
535 | 
536 | 
537 |     # only add if item label isn't already there
538 | 
539 |     if replace_label != label_name:
540 |         for existing_dock_item in (pl[section]):
541 |             for label_key in ['file-label','label']:
542 |                 if existing_dock_item['tile-data'].has_key(label_key):
543 |                     if existing_dock_item['tile-data'][label_key] == label_name:
544 |                         print "%s already exists in dock. Use --replacing '%s' to update an existing item" % (label_name, label_name)
545 |                         return False
546 | 
547 | 
548 | 
549 |     if replace_label != None:
550 |         for item_offset in range(len(pl[section])):
551 |             tile_replace_candidate = pl[section][item_offset]['tile-data']
552 |             if tile_replace_candidate[label_key_for_tile(tile_replace_candidate)] == replace_label:
553 |                 verboseOutput('found', replace_label)
554 |                 del pl[section][item_offset]
555 |                 position = item_offset + 1
556 |                 break
557 | 
558 |     new_guid = generate_guid()
559 |     if tile_type == 'file-tile':
560 |         new_item = {'GUID': new_guid, 'tile-data': {'file-data': {'_CFURLString': add_path, '_CFURLStringType': 0},'file-label': label_name, 'file-type': 32}, 'tile-type': tile_type}
561 |     elif tile_type == 'directory-tile':
562 |         if subprocess.Popen(['/usr/bin/sw_vers', '-productVersion'],
563 |                 stdout=subprocess.PIPE).stdout.read().rstrip().split('.')[1] == '4': # gets the decimal after 10 in sw_vers; 10.4 does not use 10.5 options for stacks
564 |             new_item = {'GUID': new_guid, 'tile-data': {'directory': 1, 'file-data': {'_CFURLString': add_path, '_CFURLStringType': 0}, 'file-label': label_name, 'file-type': 2 }, 'tile-type': tile_type}
565 |         else:
566 |             new_item = {'GUID': new_guid, 'tile-data': {'arrangement': arrangement, 'directory': 1, 'displayas': displayas, 'file-data': {'_CFURLString': add_path, '_CFURLStringType': 0}, 'file-label': label_name, 'file-type': 2, 'showas': showas}, 'tile-type': tile_type}
567 | 
568 |     elif tile_type == 'url-tile':
569 |         new_item = {'GUID': new_guid, 'tile-data': {'label': label_name, 'url': {'_CFURLString': add_path, '_CFURLStringType': 15}}, 'tile-type': tile_type}
570 |     else:
571 |         print 'unknown type:', tile_type
572 |         sys.exit(1)
573 | 
574 |     verboseOutput('adding', new_item)
575 | 
576 |     if position != None:
577 |         if position in [ 'beginning', 'begin', 'first' ]:
578 |             pl[section].insert(0, new_item)
579 |             return True
580 |         elif position in [ 'end', 'last' ]:
581 |             pl[section].append(new_item)
582 |             return True
583 |         elif position in [ 'middle', 'center' ]:
584 |             midpoint = int(len(pl[section])/2)
585 |             pl[section].insert(midpoint, new_item)
586 |             return True
587 |         else:
588 |             try:
589 |                 int(position)
590 |             except:
591 |                 print 'Invalid position', position
592 |                 return False
593 |             if int(position) == 0:
594 |                 pl[section].insert(int(position), new_item)
595 |             elif int(position) > 0:
596 |                 pl[section].insert(int(position)-1, new_item)
597 |             else:
598 |                 pl[section].insert(int(position)+len(pl[section])+1, new_item)
599 |             return True
600 |     elif after_item != None or before_item !=None:
601 |         for item_offset in range(len(pl[section])):
602 |             try:
603 |                 if after_item != None:
604 |                     if pl[section][item_offset]['tile-data']['file-label'] == after_item:
605 |                         pl[section].insert(item_offset+1, new_item)
606 |                         return True
607 |                 if before_item != None:
608 |                     if pl[section][item_offset]['tile-data']['file-label'] == before_item:
609 |                         pl[section].insert(item_offset, new_item)
610 |                         return True
611 |             except KeyError:
612 |                 pass
613 |     pl[section].append(new_item)
614 |     verboseOutput('item added at end')
615 |     return True
616 | 
617 | def removeItem(pl, item_name):
618 |     removal_succeeded = False
619 |     if item_name == "all":
620 |         verboseOutput('Removing all items')
621 |         pl['persistent-apps'] = []
622 |         pl['persistent-others'] = []
623 |         return True
624 |     for dock_item in pl['persistent-apps']:
625 |         if dock_item['tile-data'].get('file-data').get('_CFURLString') == item_name:
626 |             verboseOutput('found', item_name)
627 |             pl['persistent-apps'].remove(dock_item)
628 |             removal_succeeded = True
629 |     for dock_item in pl['persistent-others']:
630 |         if dock_item['tile-type'] == "url-tile":
631 |             if dock_item['tile-data'].get('label') == item_name:
632 |                 verboseOutput('found', item_name)
633 |                 pl['persistent-others'].remove(dock_item)
634 |                 removal_succeeded = True
635 |         else:
636 |             if dock_item['tile-data'].get('file-label') == item_name:
637 |                 verboseOutput('found', item_name)
638 |                 pl['persistent-others'].remove(dock_item)
639 |                 removal_succeeded = True
640 |     return removal_succeeded
641 | 
642 | def commitPlist(pl, plist_path, restart_dock):
643 |     writePlist(pl, plist_path)
644 |     if restart_dock:
645 |         os.system('/usr/bin/killall -HUP Dock >/dev/null 2>&1')
646 | 
647 | #def commitPlistLegacy(pl, plist_path, restart_dock):
648 | #    plist_string_path = path_as_string(plist_path)
649 | #    pl = removeLongs(pl)
650 | #    plist_stat = os.stat(plist_string_path)
651 | #    writePlist(pl, plist_path)
652 | #    convertPlist(plist_path, 'binary1')
653 | #    os.chown(plist_string_path, plist_stat.st_uid, plist_stat.st_gid)
654 | #    os.chmod(plist_string_path, plist_stat.st_mode)
655 | #    if restart_dock:
656 | #        os.system('/usr/bin/killall -HUP cfprefsd >/dev/null 2>&1')
657 | #        os.system('/usr/bin/killall -HUP Dock >/dev/null 2>&1')
658 | #
659 | 
660 | def label_key_for_tile(item):
661 |     for label_key in ['file-label','label']:
662 |         if item.has_key(label_key):
663 |             return label_key
664 | 
665 | 
666 | if __name__ == "__main__":
667 |     main()
668 | 


--------------------------------------------------------------------------------