TweetFollow Us on Twitter

An Introduction to Scripting Fetch

Volume Number: 22 (2006)
Issue Number: 5
Column Tag: Scripting

AppleScript Essentials

An Introduction to Scripting Fetch

by Benjamin S. Waldie

For the past several months, we have discussed ways to store and access data from AppleScript. We have talked about script properties, property list files, scriptable database applications, and more. In this month's column, I'd like to switch gears, and talk about a great application that I have been scripting quite a lot lately. That application is Fetch.Fetch is a popular FTP/SFTP client for the Macintosh. It is a commercial application, and a demonstration version is available for download from the Fetch Softworks website at <http://www.fetchsoftworks.com>. If you do not own a license for Fetch, then I encourage you to download a demonstration version, so that you may follow along with the various example scripts throughout this month's column.



Figure 1. Fetch's Well-Known Icon

All of the example code that we will discuss was written and tested with Fetch version 5.1b2. As when scripting any application, if you are using an older or newer version of Fetch, then you may notice some differences in the AppleScript terminology. If this occurs, please refer to Fetch's AppleScript dictionary for guidance in determining the proper syntax to use.

Connecting to a Server

The first thing that we are going to discuss, is the process of connecting to a remote server. For my testing, I enabled incoming FTP access in the Sharing system preference on another Mac OS X computer, on my local network. However, I could have just as easily chosen to access a remote server, such as the one hosting my website, or one of a client. For your testing, if you have a second machine running Mac OS X, then you can enable incoming FTP access (you'll probably want to ensure that your network is secure, or enable a firewall prior to doing this) for testing. Otherwise, you will need to find a server that you can access remotely via FTP or SFTP.

Making a new server connection in Fetch, is done by creating a new window, called a transfer window. See figure 2.



Figure 2. A Transfer Window Connection

Creating a transfer window is done with the use of the make command, as demonstrated in the example code below. You will want to replace my example IP address, username, password, and initial directory with ones that are relevant to the server to which you are attempting to connect.

set theServerAddress to "10.0.1.3"
set theUserName to "myUserName"
set thePassword to "myPassword"
set theDirectory to "Documents/FTP Main/"

tell application "Fetch"
   make new transfer window at beginning with properties {hostname:theServerAddress, 
   username:theUserName, password:thePassword, initial folder:theDirectory}
end tell
--> transfer window id 120663408 of application "Fetch"

As you can see from the code above, the result of making a new transfer window is a reference to the newly created window. Notice that the window is referenced by its ID. As you navigate to different folders on the remote server, the transfer window's name will change. Therefore, to refer to the newly created transfer window again later in your code, you may want to capture this result in a variable. For example:

tell application "Fetch"
   set theTransferWindow to make new transfer window at beginning with properties 
   {hostname:theServerAddress, username:theUserName, password:thePassword, initial 
   folder:theDirectory}
end tell

When a transfer window is made, its default authentication type is FTP. However, you may explicitly specify that a different type of authentication be used, such as SFTP. This can be done by specifying a value for the transfer window's authentication property, when the transfer window is created, as the following code demonstrates.

tell application "Fetch"
   make new transfer window at beginning with properties {hostname:theServerAddress, 
   username:theUserName, password:thePassword, initial folder:theDirectory, authentication:SFTP}
end tell

As previously mentioned, one way to refer to a transfer window in the future is to do so by setting a variable to the result when making a transfer window. This variable would include a reference to the transfer window using a unique ID. If you are working with an existing transfer window, you can find out its unique ID with the use of the following code:

tell application "Fetch"
   id of front transfer window
end tell
--> 120663408

Once you have a window's ID, you can refer to it later by that ID. For example:

tell transfer window id 96356736
   -- Add Code Here
end tell

You may also have the need to retrieve the name of a transfer window. However, as mentioned before, the name of the transfer window will change if you open a remote folder.

tell application "Fetch"
   name of transfer window 1
end tell
--> "10.0.1.3 -- FTP Main"

You can also refer to a transfer window by its index, or front to back order. For example, the following code would target the frontmost transfer window, which has an index of 1.

tell transfer window 1
   -- Add Code Here
end tell

Throughout this column, all of my example code will target a transfer window by its index.

Working with Remote Items (Part 1)

Now that we have discussed connecting to a server, let's begin to look at ways to interact with the remote items on that server. First, let's turn to remote folders.

Suppose you want to create a remote folder on the server. First, you will probably want to determine if the folder already exists. To do this, use the exists command. For example:

tell application "Fetch"
   tell transfer window 1
      remote folder "Job 1000" exists
   end tell
end tell
--> false

If the remote folder did not exist, then you can choose to create it. Like creating a server connection, you will use the make command to create a folder. The following example code demonstrates the proper syntax for performing this task. Figure 3 shows an example of a newly created remote folder.

tell application "Fetch"
   make remote folder at transfer window 1 with properties {name:"Job 1000"}
end tell



Figure 3. A Newly Created Remote Folder

Now that you have a remote folder, you may want to open it. To do this, use the open command, as demonstrated by the following code.

tell application "Fetch"
   tell transfer window 1
      open remote folder "Job 1000"
   end tell
end tell

Note that, after opening a folder, the name of the transfer window will be changed to reflect the currently opened folder. An example of this can be seen in figure 4.



Figure 4. An Opened Remote Folder

Uploading

We will return to interacting with remote items shortly. For now, we will discuss uploading items to the server.

To upload an item to a remote directory, you will make use of Fetch's put into command. The following example code demonstrates the proper use of this terminology. First, it will prompt the user to select a file. It will then upload that file to the currently opened remote folder on the server. Figure 5 shows an example of an uploaded item.

set thePath to choose file with prompt "Please select an item to upload:" without invisibles
tell application "Fetch"
   with timeout of 300 seconds
      put into transfer window 1 item thePath
   end timeout
end tell



Figure 5. An Uploaded Item

The put into command's only required parameter is the item parameter, which we have utilized in the previous code to indicate the path of the desired file to be uploaded. The put into command also offers the ability to specify a number of optional parameters , which can affect how the item is uploaded. For example, you might specify the resume parameter if you want to resume a previous upload. Or, you might specify the uniquename parameter, if you want Fetch to automatically assign a unique name to the item if an item with the same name that already exists. For a complete list of the put into command's optional parameters, please refer to Fetch's AppleScript dictionary.

Working with Remote Items (Part 2)

Whether or not you have uploaded items to the server yourself, there will probably be times when you will want, or need, to interact with remote items on a server. See figure 6.



Figure 6. A Folder of Remote Items

We have already discussed how to navigate folders on a server. Now, let's talk about how to get the contents of a folder. The following example code will retrieve the names of every remote item in the currently opened folder.

tell application "Fetch"
   tell transfer window 1
      name of every remote item
   end tell
end tell
--> {"Job Image 1.png", "Job Image 2.png", "Job Image 3.png"}

    NOTE: In the previous code, we referenced every remote item. A remote item can be either a file or a folder on the server. To target one or the other specifically, use either remote file or remote folder instead.

You can also retrieve numerous properties of remote items on a server, such as the remote item's path, modification date, permissions, and more. The following example code demonstrates how to retrieve the size of a remote item, in bytes.

tell application "Fetch"
   tell transfer window 1
      size of remote item "Job Image 1.png"
   end tell
end tell
--> 66242

As you work with remote items, you may also have the need to delete a remote item. This can be done by using the delete command. For example:

tell application "Fetch"
   tell transfer window 1
      delete remote item "Job Image 2.png"
   end tell
end tell

Downloading

We have covered uploading items to a server. Now, let's talk briefly about downloading items. To download an item, use the download command, and specify a folder into which the remote item should be downloaded. For example:

set theOutputFolder to path to desktop folder
tell application "Fetch"
   tell transfer window 1
      download remote item "Job Image 1.png" to theOutputFolder
   end tell
end tell
--> {file "Macintosh HD:Users:bwaldie:Desktop:Job Image 1.png"}

As you can see from the previous example code, the download command will result in a list of file references to the newly downloaded items.

Miscellaneous Tasks

When working with a transfer window, whether uploading, downloading, or otherwise, you may want to determine the status of the server connection. This can be done by accessing the transfer window's status property. For example:

tell application "Fetch"
   tell transfer window 1
      status
   end tell
end tell
--> "Connected."

The status property will return the text of the current status of the fetch window, as it appears visually at the bottom of the window itself. Other transfer window attributes, which can often be useful when scripting Fetch, are also accessible via properties. Such attributes include the elapsed transfer time, and the bytes transferred, of a current transfer.

Once you have completed your Fetch scripting, you may want to have your script close down the server connection. This can be done by using the close command to close the transfer window. For example:

tell application "Fetch"
   close transfer window 1
end tell

Recording and Next Steps

Now that we have discussed various ways to interact with Fetch via AppleScript, I should also mention that Fetch is one of those rare applications that supports recording! That is, you can click the Record button in a Script Editor window, perform tasks manually in Fetch, and those tasks will be translated into AppleScript code, and written for you automatically in the Script Editor window. See figure 7 for an example of a recorded Fetch script.



Figure 7. Recording Manual Fetch Activity

You may be asking "Why didn't he mention that Fetch was recordable in the first place?" Well, one reason I didn't mention this is because I wanted to show how easy it is to begin scripting Fetch without recording. Another reason is that there are limitations to recording AppleScript code in any application. A recorded script does not include variables, if/then statements, or repeat loops. Because of this, recorded scripts are typically not as efficient as scripts written from scratch. Recorded scripts also perform tasks exactly as you recorded them, and do not have the ability to analyze situations and take different courses of action. However, recording is still a good way to get started, and it can often be helpful in determining the proper syntax for performing that certain task when you just can't figure it out on your own. Furthermore, you always have the ability to go back and edit your recorded scripts, to make them more efficient, or to add logic to them.



Figure 8. Fetch Example Scripts

If you plan to begin scripting Fetch, another good place to start is to download the example scripts that are available from the Fetch Softworks website at <http://fetchsoftworks.com/downloads.html>. These example scripts will provide you with unlocked, editable sample code for performing tasks such as connecting to servers, uploading items, and more. See figure 8.

In Closing

Although this month's column focused specifically on using Fetch as a scriptable FTP/SFTP client, please be aware that it is not your only choice. There are other applications and tools that are used by AppleScript developers for transferring files across networks.

Transmit, available from Panic Software at <http://www.panic.com>, and Cyberduck, available at http://www.cyberduck.ch are two other popular FTP/SFTP clients for Macintosh, and are frequently utilized by scripters. URL Access Scripting, which is built into Mac OS X, can be used for performing uploads and downloads to remote servers. URL Access Scripting can be found in the System > Library > ScriptingAdditions folder in Mac OS X. Many AppleScript developers also choose to utilize the power of UNIX for performing network file transfers. The do shell script AppleScript command in Mac OS X can be used in conjunction with UNIX tools such as curl or ftp to perform such tasks.

Until next time, keep scripting!


Ben Waldie is the author of the best selling books "AppleScripting the Finder" and the "Mac OS X Technology Guide to Automator", available from http://www.spiderworks.com. Ben is also president of Automated Workflows, LLC, a company specializing in AppleScript, and workflow automation consulting. For years, Ben has developed professional AppleScript-based solutions for businesses including Adobe, Apple, NASA, PC World, and TV Guide. For more information about Ben, please visit http://www.automatedworkflows.com, or email Ben at applescriptguru@mac.com.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Evernote 6.0.15 - Create searchable note...
Evernote allows you to easily capture information in any environment using whatever device or platform you find most convenient, and makes this information accessible and searchable at anytime, from... Read more
MacUpdate Desktop 6.0.7 - Search and ins...
MacUpdate Desktop 6 brings seamless 1-click installs and version updates to your Mac. With a free MacUpdate account and MacUpdate Desktop 6, Mac users can now install almost any Mac app on macupdate.... Read more
Freeway Pro 7.0.4 - Drag-and-drop Web de...
Freeway Pro lets you design and build sophisticated responsive websites code free. With its user-oriented drag-and-drop interface, Freeway Pro helps you piece together the website of your dreams. Add... Read more
VueScan 9.5.18 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
Firetask 3.7 - Innovative task managemen...
Firetask uniquely combines the advantages of classical priority-and-due-date-based task management with GTD. Stay focused and on top of your commitments - Firetask's "Today" view shows all relevant... Read more
VOX 2.5.3 - Music player that supports m...
VOX is a beautiful music player that supports many filetypes. The beauty is in its simplicity, yet behind the minimal exterior lies a powerful music player with a ton of features and support for all... Read more
Apple iMovie 10.0.9 - Edit personal vide...
With an all-new design, Apple iMovie lets you enjoy your videos like never before. Browse your clips more easily, instantly share your favorite moments, and create beautiful HD movies and Hollywood-... Read more
MarsEdit 3.7.1 - Quick and convenient bl...
MarsEdit is a blog editor for OS X that makes editing your blog like writing email, with spell-checking, drafts, multiple windows, and even AppleScript support. It works with with most blog services... Read more
ClamXav 2.8.1 - Free virus checker, base...
ClamXav is a free virus checker for OS X. It uses the tried, tested, and very popular ClamAV open source antivirus engine as a back end. I have been working on ClamXav for more than 10 years now, and... Read more
CrossOver 14.1.4 - Run Windows apps on y...
CrossOver can get your Windows productivity applications and PC games up and running on your Mac quickly and easily. CrossOver runs the Windows software that you need on Mac at home, in the office,... Read more

This Week at 148Apps:June 22-26, 2015
June's Summer Journey Continues With 148Apps How do you know what apps are worth your time and money? Just look to the review team at 148Apps. We sort through the chaos and find the apps you're looking for. The ones we love become Editor’s Choice,... | Read more »
World of Tanks Blitz celebrates its firs...
Today marks the first anniversary of the launch of World of Tanks Blitz, the mobile version of the PC tank battler, World of Tanks. World of Tanks Blitz launched on iOS and Android on June 26th last year and to celebrate, Wargaming is giving all... | Read more »
Heroes and Castles 2 Has its Own Standal...
Heroes and Castles 2 is a third-person castle defense game from the same team behind Block Fortress and Bug Heroes. It's cool, it's fun, and now it has its very own free version. [Read more] | Read more »
Formula Cartoon All-Stars Lets You Race...
Ever want to pit your favorite characters from shows like Steven Universe, Adventure Time, and Regular Show against each other in a not quite death race? Well once upon a time you could, but Formula All Stars Touch N' Go doesn't exist anymore. Hope... | Read more »
Retype - Typography Photo Editor (Photo...
Retype - Typography Photo Editor 1.0 Device: iOS Universal Category: Photography Price: $2.99, Version: 1.0 (iTunes) Description: Retype is built out of passion for great typography and it's all about adding text to photo with style... | Read more »
Hungry Shark Evolution Celebrates Shark...
Shark Week is almost here, as is Independence Day, so naturally Hungry Shark Evolution is going to get in on the action. Yes, even the fireworks. [Read more] | Read more »
The New Trivia Crack Will Feature a Musi...
It's official: iHeartMedia (you may know them from iHeartRadio) will be in charge of providing music-related questions for Trivia Crack's upcoming sequel. Also Trivia Crack is getting a sequel. [Read more] | Read more »
Toca Life: City (Education)
Toca Life: City 1.0 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0 (iTunes) Description: Welcome to Toca Life: City, a metropolis filled with everyday fun! Customize characters, explore exciting locations and... | Read more »
Ironkill's Big New Update is Big an...
The other popular robot fighting game on the App Store, Ironkill, has received a pretty substantial update today. We're talking new bots, new rewards, graphical tweaks; the works. [Read more] | Read more »
iOS Users, Say Hello to Dragon Quest VI:...
The App Store is no stranger to the Dragon Quest series, and has had its fair share of ports for quite some time. That tradition is staying pretty much exactly the same with the release of Dragon Quest VI: Realms of Revelation. [Read more] | Read more »

Price Scanner via MacPrices.net

MacBook Airs on sale for up to $75 off MSRP
Save up to $75 on the purchase of a new 2015 13″ or 11″ 1.6GHz MacBook Air at the following resellers. Shipping is free with each model: 11" 128GB MSRP $899 11" 256GB... Read more
Apple’s Education discount saves up to $300 o...
Purchase a new Mac or iPad at The Apple Store for Education and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free,... Read more
Save up to $600 with Apple refurbished Mac Pr...
The Apple Store has Apple Certified Refurbished Mac Pros available for up to $600 off the cost of new models. An Apple one-year warranty is included with each Mac Pro, and shipping is free. The... Read more
Mac Pros on sale for up to $260 off MSRP
B&H Photo has Mac Pros on sale for up to $260 off MSRP. Shipping is free, and B&H charges sales tax in NY only: - 3.7GHz 4-core Mac Pro: $2799, $200 off MSRP - 3.5GHz 6-core Mac Pro: $3719.99... Read more
Save up to $400 on 2014 15-inch Retina MacBoo...
B&H Photo has previous-generation 2014 15″ Retina MacBook Pros on sale for up to $400 off original MSRP. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.2GHz Retina MacBook Pro... Read more
15-inch Retina MacBook Pros on sale for up to...
B&H Photo has new 2015 15″ Retina MacBook Pros on sale for up to $125 off MSRP including free shipping plus NY sales tax only: - 15″ 2.2GHz Retina MacBook Pro: $1899.99 $100 off - 15″ 2.5GHz... Read more
College Student Deals: Additional $100 off Ma...
Take an additional $100 off all MacBooks and iMacs at Best Buy Online with their College Students Deals Savings, valid through July 11, 2015. Anyone with a valid .EDU email address can take advantage... Read more
Apple refurbished Time Capsules available for...
The Apple Store has certified refurbished Time Capsules available for $100 off MSRP. Apple’s one-year warranty is included with each Time Capsule, and shipping is free: - 2TB Time Capsule: $199, $100... Read more
Newsweek Launches iPhone App
The venerable weekly news magazine Newsweek, owned by IBT Media, has announced the launch of its first iPhone app. The new app is available through Apple’s App Store and will allow consumers to read... Read more
New Initiative Covering 80 Million Homes Will...
Today, Internet service providers, equipment suppliers and retail equipment manufacturers joined the Consumer Electronics Association (CEA) and the National Cable & Telecommunications Association... Read more

Jobs Board

Architect / Senior Software Engineer, *Apple...
**Job Summary** Apple Pay is already changing our pay-habit in a deeper and fundamental level. We are looking for a software engineer with a passion for large scale inte Read more
Project Manager, *Apple* Retail New Store O...
**Job Summary** An Apple Retail New Store Openings & Remodels Project Manager is responsible for successfully managing the openings, remodels, and small works of Read more
*Apple* Solutions Consultant - Retail Sales...
**Job Summary** As an Apple Solutions Consultant (ASC) you are the link between our customers and our products. Your role is to drive the Apple business in a retail Read more
Program Manger, WW *Apple* Direct Fulfillme...
**Job Summary** We are seeking a business analyst to work within our Worldwide Apple Direct Fulfillment Operations team. This role will work closely with related program Read more
Hardware Design Validation Engineer - *Apple...
**Job Summary** The Apple Watch team is looking for a Hardware Design Validation Engineer. This person will be part of the Apple Watch hardware team with Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.