AppleScripting the Finder Preview

Transcription

1 Automate Your Mac AppleScripting the Finder Preview Full Version Available at By Ben Waldie

2 Table of Contents About this ebook 3 How to Use this ebook 4 Installing the Companion Scripts 5 Chapter 1: Introduction 6 Goals of this Book 7 AppleScript 7 Scriptable Applications 8 What You Need to Get Started 9 Chapter 2: Finder Scripting Overview 10 What is Finder Scripting? 10 Benefits of Finder Scripting 11 Why Finder Scripting is Necessary 12 What Can You Do With Finder Scripting? 13 Chapter 3: Recording Scripts in the Finder 15 Getting Started with Recording 15 Benefits of Recording 16 Limitations of Recording 17 Improving Recorded Scripts 18 Chapter 4: Finder Dictionary 21 Introduction to Application Dictionaries 21 Accessing the Finder Dictionary 22 Navigating the Finder Dictionary 24 Classes, Objects, Properties, and Commands 26 Finder Object Model 30 Chapter 5: Working with the Finder Application 34 Application Object 34 Finder Application Properties 36 Finder Application Commands 39 Chapter 6: Referring to Objects 42 Object References 42 AppleScript Paths 43 POSIX Paths 46 Chapter 7: Working with Processes 47 About Processes 47 Types of Process Objects 49 Process Properties 50 Interacting with Processes 52

3 Table of Contents Continued Chapter 8: Working with Items 55 Item Object Types 55 Item Properties 56 Item Commands 60 Shared Commands 62 Chapter 9: Working with Containers 69 Types of Container Objects 69 Working with Containers 69 Container Object Properties 71 Interacting with Container Objects 73 Chapter 10: Working with Files 77 Types of File Objects 77 File Object Properties 78 Interacting with File Objects 80 Chapter 11: Working with Windows 83 Types of Window Objects 83 Window Object Properties 85 Interacting with Window Objects 91 Chapter 12: Putting it All Together 93 Example Script 1 Archiving Files 93 Example Script 2 Copying Selected Paths to the Clipboard 95 Example Script 3 Listing Folder Contents 96 Example Script 4 Switching Window Views 99 Example Script 5 File Type/Creator Type Assignment 99 Example Script 6 Locking and Unlocking Finder Items 102 Example Script 7 Ejecting Disks 103 Chapter 13: In Conclusion 104 Finder Scripting Resources 104 License Agreement 107

4 About this ebook The Author Ben Waldie is president of Automated Workflows, LLC, a company offering AppleScript, Automator, and workflow consulting services to Mac-based businesses. For years, Ben has developed professional automated solutions for companies such as Abercrombie & Fitch, Adobe Systems, Apple Inc., CNN, Microsoft, NASA, PC World, and Time Magazine. Ben is the author of Automator for Mac OS X 10.5 Leopard Visual QuickStart Guide (Peachpit Press), has written AppleScript and Automator content for Apple.com, Macworld, MacTech, MacScripter.net, and X-Ray Magazine, and is the host of the Mac Automation Made Simple video podcast (Peachpit Press). Ben is also the author of an AppleScript training CD for the Virtual Training Company, is a frequent presenter at Macworld Expo and other events, and is president of The Philadelphia Area AppleScript Users Group. Visit Automated Workflows, LLC online: The Book Optimized for easy on-screen reading, yet perfect for printing, this ebook has been uniquely formatted and hyperlinked for fast access and quick learning. 3

5 How to Use this ebook On-Screen Viewing We recommend using Adobe Acrobat or the free Adobe Reader to view this ebook. Apple Preview and other third-party PDF viewers may also work, but many of them do not support the latest PDF features. For best results, use Adobe Acrobat/Reader. To jump directly to a specific page, click on a topic from either the Table of Contents on the first page or from the PDF Bookmarks. In Adobe Reader, the PDF Bookmarks can be accessed by clicking on the Bookmarks tab on the left side of the screen. In Apple Preview, the PDF Bookmarks are located in a drawer (Command-T to open). If your mouse cursor turns into a hand icon when hovering over some text, that indicates the text is a hyperlink. Table of Contents links jump to a specific page within the ebook when clicked. Text links that begin with http or ftp will attempt to access an external web site or FTP server when clicked (requires an Internet connection). Printing Since this ebook utilizes a unique horizontal page layout for optimal on-screen viewing, you should choose the Landscape setting (in Page Setup) to print pages sideways on standard 8.5 x 11 paper. If the Orientation option does not label the choices as Portrait and Landscape, then choose the visual icon of the letter "A" or person s head printed sideways on the page (see example below). 4

6 Installing the Companion Scripts Requirements Most of the topics covered in this book will be relevant to Finder scripting in most versions of the Mac OS. However, since some aspects of the AppleScript language may change from system to system, you should be aware that the companion scripts were written using Mac OS X with Finder , AppleScript 1.9.3, and Script Editor 2.0 installed. If you are using a different version of any of the software specified above, please note that the functionality of some of the companion scripts may vary slightly. Software Installation The collection of companion scripts and data files from this book have been provided with your purchased ebook download, and are included in a directory called Finder Scripts. Nested inside that directory are further subdirectories labeled for the chapter to which the example files apply. Not all chapters have example files in the Finder Scripts collection. Move the Finder Scripts directory to a convenient location on your hard disk from which you can open the files with Script Editor. 5

7 Chapter 1 Introduction 6 F inder scripting was first introduced in the era of Mac OS 7.1, right around the time of the initial release of AppleScript. At that time, Finder scripting, and AppleScript itself for that matter, were not even included with the core OS. Rather, an AppleScript runtime kit and Finder scripting software package were available for purchase separately. With the introduction of system 7.5, AppleScript and Finder scripting were integrated into the Mac OS, where they have been ever since. Today, with Mac OS X, Finder scripting is still an integral part of AppleScript development. Since its introduction, Finder scripting has been quite popular among AppleScript developers, perhaps due to the fact that everyone needs to interact with the Finder. As you are already aware, the Finder itself provides a user interface for manually navigating and organizing files and folders on the computer. AppleScript allows us to take this interaction one step further. By writing scripts that talk directly to the Finder, we are able to control aspects of the Finder s interface and organizational structure without user interaction. With the use of AppleScript, we can begin to automate many of the Finder-related tasks that we perform on a daily basis, such as navigating and building folder structures, deleting, duplicating, moving, opening, renaming items, and more. While these tasks may sound simple enough, when performed repetitively, they can become quite time consuming. In addition, by integrating Finder scripting with the scripting of other applications, AppleScript can be used to automate very complex workflows.

8 Chapter 1: Introduction Goals of this Book Throughout this book, we will take an in-depth look at scripting the Finder. We will discuss some of the many benefits of Finder scripting, and find out why scripting the Finder is sometimes necessary in order to achieve certain automation goals. We will also explore the Finder s AppleScript terminology, and with the use of various examples, we will show how to automate the Finder with AppleScript. By following the examples in this book, you will put yourself well on the way to creating scripts that will take you to the next level of automation possibilities. In the final chapter of this book, we will pull together the things that we have discussed, in order to create some useful AppleScript applications that can be used to automate some common time consuming tasks many users perform on a regular basis. AppleScript Before we get started with the Finder, we should briefly discuss AppleScript itself. AppleScript is a scripting language that is built directly into the Mac OS. It is used to automate repetitive and/or timeconsuming tasks in existing applications, as well as the Mac OS. AppleScript is actually a tool that can be used by virtually every Macintosh user. Referred to by many as programming for the rest of us, AppleScript s English-like syntax provides even novice users with the ability to examine, navigate, and even write simple scripts. By allowing a user to write and run scripts that control an application on the computer, AppleScript provides the ability to easily automate routine tasks such as backups, image processing, page layout, and more. In addition, AppleScript s ability to interact with many different applications can allow more advanced users to automate even the most complex and demanding workflows. 7

9 8 Chapter 1: Introduction Scriptable Applications As previously mentioned, AppleScript is typically used to automate existing applications on a Mac. In order for an application to be automated with AppleScript, it must be scriptable, meaning that it will respond to AppleScript commands. While not every application on the Mac is scriptable, many well-known applications are scriptable. In addition, AppleScript is becoming more popular within the Macintosh community, and more and more scriptable applications are being released on a regular basis. Some scriptable applications are also recordable. What this means is that, using an AppleScript editor such as Script Editor, which is included with the Mac OS, you can actually record many manual tasks within the application as AppleScript code. This can be an excellent way to learn how to script an application. However, it is important to note that not every scriptable application is recordable. In fact, very few scriptable applications are recordable. The way to determine if an application is recordable is to begin recording in your script editor, and then go into the application and perform some manual tasks. If AppleScript code is generated in your script editor as you perform these tasks, then the application is recordable. Yes, the Finder is recordable, and we will touch on this in a future chapter. Another level of AppleScript support found in some applications is the ability to trigger AppleScripts from directly within the application itself. An application that provides this ability is considered to be attachable. Some attachable applications allow AppleScripts to be triggered from built-in script palettes or menus. Mac OS X also contains a systemwide script menu, which can allow you to trigger scripts from within virtually any application. One thing to pay close attention to regarding any scriptable application is that with every application update, the application s AppleScript terminology may change. This may occur when new features and options are introduced into the application. As you begin scripting various applications, please be sure to test your scripts thoroughly before introducing new application versions, as some code changes may be required.

10 Chapter 1: Introduction What You Need to Get Started Since this book focuses specifically on Finder scripting, it assumes that you already have at least an elementary knowledge of the core AppleScript language. If you are completely new to AppleScript, then you should, at minimum, review the AppleScript Language Guide, which can be found on Apple Computer s AppleScript web site. This document explains the terminology of the core AppleScript language. In addition, Apple Computer s AppleScript web site also contains many other AppleScript related documents and developer resources. If you prefer a more in-depth introduction to the basics of AppleScript, you should consider an introductory AppleScript book, such as AppleScript (available from Peachpit.com), which serves as an excellent resource and reference guide. Software Utilized in this Book Most of the topics covered in this book will be relevant to Finder scripting in most versions of the Mac OS. However, since some aspects of the AppleScript language may change from system to system, you should be aware of which versions of software were used in the writing of this book. This book and all topics and scripts contained within it were written using the following software: 4 Mac OS X version AppleScript version Finder version Script Editor version 2.0 If you are using a different version of any of the software specified above, please note that some functionality discussed in this book may vary slightly, or may not be relevant. What s Next Now that we have covered a few introductory topics, we are ready to start looking at the Finder. During the next several chapters, we will look at aspects of the Finder that are important to understand before actually starting to write AppleScript code for scripting the Finder. Since some readers may be fairly new to AppleScript, as we move along, we will also touch briefly on some more generic aspects of application scripting. 9

11 Chapter 2 Finder Scripting Overview s the term indicates, Finder scripting refers to Aautomating the Finder with AppleScript. In this chapter, we will discuss what scripting the Finder means, its benefits, and what is possible once you have a fair understanding of scripting the Finder. What is Finder Scripting? In order to comprehend scripting the Finder, it is first important to understand that, while the Finder is referred to by Apple as one of the main features of the Mac OS, it is actually an application. The Finder is the application that provides a graphical representation of the complex folder and file structure that is our computer. With the Finder, we can logically organize this file and folder structure, navigate through it, and more. Since the Finder is an application, it is treated as such with regard to its automation with AppleScript. Just like when scripting any other application, you will address the Finder as an application. For example, the following code will bring the Finder application to the front: Code Listing 2.1 tell application Finder activate end tell 10

12 Chapter 2: Finder Scripting Overview By automating the Finder application with AppleScript, we are able to create automated processes that interact with and modify the objects within the Finder, as well as the Finder s interface. Benefits of Finder Scripting As with the AppleScript automation of other applications, there are benefits to scripting the Finder. Primarily, scripting the Finder can allow you to automate time consuming tasks and processes, which would otherwise need to be done manually. Personally, I feel that file and folder maintenance tasks, such as navigating folder structures, moving, copying, renaming files and folders, etc., are some of the most time consuming tasks on the Mac. However, they do not need to be. Many of these tasks are performed repetitively, and can be automated in the Finder with AppleScript. Finder scripting can also allow you to add new custom features and functionality into the Finder. For example, in the Mac OS X 10.3 Finder, typing command + option + M will minimize all opened windows. However, there is no key command to redisplay all minimized windows. Yet, this could be done with an AppleScript. In fact, there is actually a sample AppleScript included with Mac OS X 10.3 that does just this. It is called Finder Windows Show All, and it can be found under Applications > AppleScript > Example Scripts > Finder Scripts. 11

13 12 Chapter 2: Finder Scripting Overview Why Finder Scripting is Necessary Finder scripting has always been an important part of AppleScript automation. In the past, you would rarely create a script that did not involve the Finder in some way. Today, some applications and scripting additions provide functionality similar to the functionality found in the Finder. For example, consider the latest release of the System Events application in Mac OS X. The System Events application is a background application, which allows users to automate system-related tasks in Mac OS X via AppleScript. Based on what can be found in this application, it appears that Apple may be beginning to move some file, folder, and process specific tasks out of the Finder, although at this time, they can still be found in both the Finder and System Events. In addition, with the ability to trigger UNIX commands from AppleScript in Mac OS X, it is now possible to write AppleScripts that perform file system related tasks without the Finder. For example, AppleScript can trigger UNIX commands that create folders, delete, duplicate, move, rename items, and more. To trigger UNIX commands from AppleScript, use the do shell script command, which is part of the Standard Additions scripting addition in Mac OS X. For example: Code Listing 2.2 do shell script ls../documents/ To use quoted text, you will need to escape your quote marks with a backslash. For example: Code Listing 2.3 do shell script ls \../Documents/\ However, what does all of this mean for Finder scripting? Does it mean that Finder scripting will someday be obsolete? I don t think so. It means that Apple may be considering moving certain types of system-related tasks into a centralized location, like System Events. It is not yet known whether these tasks will remain in the Finder as well as in System Events. However, regardless, it will not eliminate Finder scripting. Finder scripting will still be necessary for controlling aspects of the Finder s user interface. Regarding the ability to trigger UNIX commands from AppleScript, this would require users to possess an understanding of UNIX, which is not typically a common trait among beginning scripters. Therefore, the application of choice to automate the Macintosh file and folder system, at least for beginners, will remain the Finder.

14 Chapter 2: Finder Scripting Overview What Can You Do With Finder Scripting? Finder scripting can be used to automate almost any task that you can perform manually in the Finder. For example, AppleScript code can be written to perform basic Finder functions such as opening folders, arranging folder windows, and trimming file and folder names. For some examples of basic Finder scripting, check out the sample scripts found under Applications > AppleScript > Example Scripts > Finder Scripts in Mac OS X. See figure 2.1. Figure 2.1 Example Finder Scripts in Mac OS X Finder scripting can also be used to automate more complex tasks and processes. For example, using Finder scripting, you could create a script that would automatically scan through an entire folder structure, searching for every instance of a PDF document. For each detected PDF file, the script could remove certain characters from the file name, such as spaces, and replace them with underscores. Even a multi-application workflow can use Finder scripting to pull it together. For example, a photographer may take hundreds of photos during a daily photo shoot. Upon returning to the office, each photo needs to be downloaded to the computer, and organized in some logical manner. This is a prime example of a repetitive and time-consuming task that could be made more efficient with the use of AppleScript and Finder scripting. In order to aid with this process, a script could be created that uses the Finder to detect when a camera card is inserted, build a folder structure for the current date, download all photos into the folder structure, and rename them with a predetermined unique naming convention. Next, the script could proceed to interact with another application, such as Adobe Photoshop, to perform specific image manipulation tasks on each downloaded photo. Again, there is virtually no limit to the Finder tasks that you can automate with AppleScript. As you begin creating more complex workflows, you will see how the Finder will quickly become a precious tool for interacting with the computer s file system. 13

15 Chapter 2: Finder Scripting Overview What s Next Now that we understand the basic concepts and benefits of Finder scripting, we are ready to get started with some actual AppleScript automation. In the next chapter, we will look at recording scripts in the Finder, which can be a helpful learning tool for both users that are new to AppleScript and new to scripting the Finder. 14

16 License Agreement This work (THE BOOK) contains copyrighted material, and its use is subject to the following License Agreement, which is a legal agreement between you (the purchaser of the book) and Automated Workflows, LLC (the publisher of the book), a Pennsylvania Limited Liability Corporation in the United States. Please read this License Agreement carefully. BY USING THE BOOK, YOU ARE AGREEING TO THE TERMS OF THIS AGREEMENT. IF YOU DO NOT AGREE TO THE TERMS OF THIS AGREEMENT, YOU MAY NOT USE THE BOOK AND MUST DESTROY ALL COPIES OF THE BOOK THAT ARE IN YOUR POSSESSION. Automated Workflows, LLC agrees to grant, and you agree to accept, a non-exclusive, non-transferable license to install and use THE BOOK under the following terms and conditions: 1. You may download and/or install THE BOOK onto your personal or business computer or other electronic device. You may make reasonable backup copies of THE BOOK to avoid losing it. You may not distribute THE BOOK to others, or make THE BOOK available for others to copy or download. THE BOOK may not be installed on a networked device or drive that is freely accessible to others. 2. You may not distribute any content contained within THE BOOK, with the exception of brief quotations to be used for the purpose of publishing a critical review of THE BOOK or publicizing THE BOOK. 3. You may not distribute, in whole or in part, THE BOOK's companion files and scripts. 4. You may print THE BOOK for your personal use. You may not distribute printed pages from THE BOOK to others. 5. You do not own THE BOOK. You are being provided a single-user license to use THE BOOK. THE BOOK is owned by Automated Workflows, LLC and is protected by United States copyright laws and international copyright treaties. 6. Automated Workflows, LLC makes no guarantees that the information contained within THE BOOK is error-free. THE BOOK is provided "as is", without warranty of any kind, either express or implied or statutory, including, without limitation, implied warranties of merchantability and fitness for a particular purpose. 7. The entire risk as to the results and performance of THE BOOK is assumed by you. In no event will Automated Workflows, LLC be liable for any damages, including, without limitation, incidental and consequential damages and damages for lost data or profits arising out of the use or inability to use THE BOOK, material contained within THE BOOK, or THE BOOK's companion files and scripts. In no event shall Automated Workflows, LLC's liability exceed the license fee paid for THE BOOK, if any. Copyright 2005 Automated Workflows, LLC. AppleScript is a trademark of Apple, Inc. All other third-party names, products and logos referenced within this Book are the trademarks of their respective owners. All rights reserved. 107