TweetFollow Us on Twitter

Combining Two Faces OF OS X: AppleScript and Java

Volume Number: 21 (2005)
Issue Number: 4
Column Tag: Programming

Combining Two Faces OF OS X: AppleScript and Java

by David Miller

Bridging the Gap

Roll Your Own Solution

Welcome

With the announcement and previews of the new version of Apple's operating system, Tiger, Mac users are starting to get excited about its new features. End users are looking forward to the conveniences brought on by features such as Spotlight and Dashboard, while developers are salivating over frameworks bundled with Tiger such as Core Data and Core Image. And while each new version of OS X has introduced enhancements that are compelling enough to convince users and developers to upgrade, a few ragged edges have also found their way into the foundation.

Two of OS X's highly-touted features are its excellent Java support, and the ease with which automated workflows are created via AppleScript. This article will focus on one of the ragged edges between these two components.

Part 1: AppleScript

AppleScript has been a part of the Mac OS since System 7, and not surprisingly, has had its share of ups and downs since its debut; the transition from OS 9 to OS X was particularly rough on it. Scripts running in the early versions of OS X often had to interact with applications nestled within both the Aqua and the "Classic" emulation layers; while this solution was not a huge obstacle for scripters, it was by no means an elegant solution.

To make matters worse, early versions of Carbon and Cocoa applications often included shoddy AppleScript support due to the amount of effort required to make the jump from OS 9 to OS X. In fact, this situation is just as relevant as it ever was, as developers are understandably more concerned about getting their applications to take advantage of OS X's newest features than to prolong the development cycle to include a "bonus" such as AppleScript support. Frameworks such as Rendezvous, WebKit, and Cocoa Bindings have allowed developers to provide more bang for their applications' buck, yet AppleScript often seems to be left behind. iTunes was an excellent example of this situation, as it did not receive substantial AppleScript support until version 3, (and many of Apple's staple applications such as Safari still don't play nicely with AppleScript).

Yet, ironically enough, OS X has become a bigger and better playground for scripters with each successive release:

  • the Script Menu item has effectively replaced the Script Runner application, and has brought with it the ability to execute scripts written in a variety of flavors besides AppleScript (Perl, Python, and a variety of shell flavors: bash, zsh, tcsh, etc.);
  • the addition of AppleScript Studio to OS X's developer tools has allowed scripters to create full-fledged Cocoa applications with AppleScript and Aqua's native widget set and, in doing so, introduced improvements to the language and AppleEvent model;
  • And Tiger will introduce Automator, an application and framework that will make scripting almost as simple as point-and-click.

AppleScript Studio, as mentioned above, was built upon an Objective-C--AppleScript bridge that allows scripts access to the methods and properties of Cocoa objects. However, this wasn't the first instance of Cocoa applications being written in a language other than Objective-C.

Part 2: Java

One of OS X's major selling points is its tight coupling with Java; heavy-weight tools such as the JBoss J2EE application server and Apache Tomcat can be installed and running on a Mac with a minimal amount of configuration. However, OS X's Java support doesn't end at the command-line. While Cocoa's "native" language is Objective-C, Cocoa's foundation classes have also been ported to Java which, in theory, gives developers the choice between two object-oriented languages for their Cocoa applications.

The above statement is qualified with "in theory" because while it is entirely possible to build a Cocoa application with Java, it is by no means a common occurrence. Cocoa's ancestor, with which it still shares many traits (including the NS prefix for class names) was created for Objective-C's object model within the NextStep environment, and then retro-fitted onto the Java object model for the release of OS X. Creating the Java-Cocoa classes was a nice gesture on Apple's part, but developers have chosen to forego Java and learn Objective-C for Cocoa hacking for several reasons:

  • The Cocoa Java classes are treated as second-class citizens when compared to their Objective-C counterparts, both in terms of their development and documentation,
  • And building Cocoa applications with Objective-C is much like placing a round peg in its round hole, whereas building them with Java is akin to forcing the round peg into a square hole.

And because the square hole seems to be an afterthought, it often gets overlooked when it comes time for framework releases and updates; it is no secret that the documentation and implementation for the Cocoa-Java classes is lacking; frameworks such as the Address Book have become widely accepted in Objective-C applications yet still have no Java hooks. Take for instance, the NSAppleScript class, which is used in the following (simplified) Java class:

Listing 1: NextTrack.java

NextTrack.java

A simple Java class that makes use of NSFoundation's classes for interacting with AppleScript.

Import com.apple.cocoa.foundation.*;

public class NextTrack {

  public static void main(String[] args) {
    String script = "tell application \"iTunes\"\n"
      + " next track \nend tell";
    NSAppleScript myScript =  new NSAppleScript(script);
    NSMutableDictionary errors= new NSMutableDictionary();
    NSAppleEventDescriptor results =
         myScript.execute(errors);
  }
}

The above code should accomplish the same result when run through OS X's Java interpreter as the following snippet of AppleScript when run in Script Editor:

Listing 2: NextTrack.scpt

NextTrack.scpt()
A simple script that will tell iTunes to start playing the next track.

tell application "iTunes"
   next track
end tell

...and the following Objective-C method when invoked by another class:

Listing 3: NextTrack.m

NextTrack.play()

The Objective-C equivalent to the Java code in Listing 1, and the AppleScript shown in Listing 2:

- (void) play
{
   NSAppleScript *play =
      [[NSAppleScript alloc]
         initWithSource:
   @"tell application \"iTunes\"\n next track\n end tell"];
   [play executeAndReturnError:nil];
}

And not surprisingly, the native AppleScript and Objective-C versions shown in Listings 2 and 3 execute precisely as expected; now let's see how the Java version fairs. Compiling the Java code can be accomplished through the following command in Terminal:

javac -classpath .:/System/Library/Java/
   AppleScriptTest.java

... and subsequently executed with...

java -classpath .:/System/Library/Java/ AppleScriptTest

We would expect that the next song in our iTunes playlist would begin playing after executing the above command. However, once the shell gives control to the Java interpreter to execute our program, things go downhill -- the program hangs as soon as the NSAppleScript's execute method is invoked. And even worse, the AppleScript is never executed, which leaves leaving Java developers who wish to incorporate AppleScript into their programs in a bind.

But all is not lost; Thanks to OS X's command-line interface and its osascript utility, it is possible to make a home-made solution to pass information from AppleScript to Java. Traditionally this would process would be done by using an instance of the NSAppleEventDescription class, yet we have seen that this will not work in Java. Let's see how we can overcome this bug in OS X.

Rolling Your Own Solution

Our homegrown solution has two requirements: (1) that we can execute AppleScripts from within Java's sandbox, and (2) that we are able to send the result of a script back to the sandbox. Luckily, both steps can be taken care of by the osascript command.

Included in OS X since its initial release, the osascript command executes AppleScripts in the same way that scripts from traditional languages (such as Perl, Python, and Bash) are executed: through the shell. In terms of the shell, the main difference between executing shell scripts and AppleScripts is that the former can be made executable through the use of UNIX permissions and the she-bang line (the first line of a script, which indicates which program should be interpret the script), while the osascript program must interpret AppleScripts. However, osascript follows the same rules as every other UNIX utility, namely:

  • The program will return 0 to the shell if the AppleScript was executed successfully, or 1 if the script execution terminated abnormally,
  • And the script's result will be echoed to one of stdout or stderr, depending on the return value mentioned above.

And like most other UNIX commands, all you need to know about osascript can be found out through its man page by typing man osascript. For now, all we need to know is that the command osascript test.appleScript will attempt to execute the file test.appleScript in the exact same way as though the script was executed in one of the "traditional" methods, such as through the Script Menu or executing it from within Script Editor.

The Solution, Part 1: Executing AppleScript From Java

Thus, it is relatively trivial to write a wrapper for the osascript program that will capture the script's result and store it in a String; the code shown in Listing 5 does just that.

Listing 5: AppleScript.java

AppleScript.run()

We can use the osascript command to run an AppleScript file via the shell. The output of the script will be echoed to standard out if successful, or sent to standard error if not. Either way, it can be trapped by using an InputStream and then inspected as required.

public String run(File script) throws AppleScriptException,
   IOException,
   FileNotFoundException,
   java.lang.InterruptedException {

ArrayList cmd = new ArrayList(); 
cmd.add("/usr/bin/osascript"); 

// add necessary command-line switches here...

// create an array to store the parameters
cmd.add(script.getPath());
String[] cmdArray = (String[]) cmd.toArray(new String[0]);

// run the script
Process result = Runtime.getRuntime().exec(cmdArray);
result.waitFor();

String line;
StringBuffer output = new StringBuffer();

/* if something bad happened while trying to run the script, throw an AppleScriptException 
   letting the user know what the problem was */
if (result.exitValue() != 0) {
   
  // read in the description of the error
   BufferedReader err = new BufferedReader(new
       InputStreamReader(result.getErrorStream()));
   while ((line = err.readLine()) != null) {
       output.append(line + "\n");
   }
   
   // and throw an exception describing what the problem was throw new 
      AppleScriptException(output.toString().trim());
         
// otherwise the script ran successfully
} else {

   /* read in the output */
   BufferedReader out = new BufferedReader(new
       InputStreamReader(result.getInputStream()));
   while ((line = out.readLine()) != null) {
      output.append(line + "\n");
   }
}

The Solution, Part 2: Returning AppleScript Results to Java

Now you may be asking yourself, "What is the result of an AppleScript?" A script's result is defined to be the value of the last statement in the script. For example, the result of the following script will be a reference to the track that is currently playing iTunes:

Listing 4: GetCurrentTrack.scpt

GetCurrentTrack.scpt

A simple AppleScript used to retrieve the current track in iTunes.

tell application "iTunes"
   set mytrack to current track
end tell

If executed through Script Editor, the result of the above script will be an instance of iTunes' Track class, which contains all of the information retained by iTunes (such as its artist, album, rating, etc.) for the track that is currently playing. However, if the above script is executed through the osascript command after saving it to a file, the following result will be echoed back to the Terminal:

Listing 4: Sample Result

The result of converting an AppleScript object to a textual representation.

"class cFlT" id 105

The two listings included above are merely different representations of the same result. Listing 4 is the result of converting an AppleScript object to text for echoing to the shell; and in the process of converting the object all information about the track that we were hoping to use in our Java program is lost. However, there is a way around this problem: by changing our script so that its result can be parsed as text, we can then capture that information without changing our Java code.

For example, we can retrieve the information for the currently playing track in iTunes and echo it to the shell by passing the following file to osascript :

Listing 5:GetCurrentTrack.scpt

GetCurrentTrack.txt

The following script will result in the information for the current track being echoed out to standard out with the fields delimited by a tab character (\t).

set tab to "\t"
tell application "iTunes"
   try
      set r to current track
      set myvalue to (album of r & tab & artist of r & tab & bit rate of r & 
         tab & comment of r & tab & compilation of r & tab & composer of r & tab & 
         database ID of r & tab & (date added of r as string) & tab & disc count 
         of r & tab & disc number of r & tab & duration of r & tab & enabled of r 
         & tab & (EQ of r as string) & tab & (genre of r as string) & tab & (kind of 
         r as string) & tab & (modification date of r as string) & tab & played 
         count of r & tab & (played date of r as string) & tab & rating of r & tab & 
         sample rate of r & tab & size of r & tab & track count of r & tab & track 
         number of r & tab & year of r & tab & name of r)
   on error
      (* do nothing *)
   end try
end tell

As can be seen from the listing, the script will return the fields of the current track in a tab-delimited format. The Java wrapper method will store this information as a String, which can then be parsed to extract the relevant fields of the Track that we are looking for. The following code illustrates how to do exactly that:

Listing 6: CurrentTrack.java

CurrentTrack.getCurrentTrack()

The following method will return an object containing all of the information for the track that is currently playing in iTunes. After the tab-delimited result is stored, it is broken up into its individual fields, which are used to set the fields of the Track instance. The Calendar.parseAppleScriptDate method is used to convert a textual representation of an AppleScript date field to a java.util.Date object; and numbers must be parsed as Integers before setting our track's attributes.

public static Track getCurrentTrack() throws AppleScriptException {

   try {
      
      File script = new File();

      // <snip>
      // store a get a reference to a file containing the
    // AppleScript shown in Listing 5
      // </snip>

      AppleScript as = new AppleScript(script);
      String result = as.run();

      // split the output on the tab character (\t) to 
      // break it into the individual fields
      String[] bits = result.split("\t");
      
      // if we only have one item, then no track was returned
      if (bits.length <= 1) {
         throw new AppleScriptException("No current track");
      }

      // the object used to store all of the info
      Track current = new Track();
      
      // loop through all fields and set the corresponding
      // attributes of the Track object...
      current.setAlbum(bits[0]);
      current.setArtist(bits[1]);
      current.setBitRate(Integer.parseInt(bits[2]));
      current.setComment(bits[3]);
      current.setCompilation(
         new Boolean(bits[4]).booleanValue());
      current.setComposer(bits[5]);
      current.setId(Integer.parseInt(bits[6]));            
      current.setDateAdded(
         Calendar.parseAppleScriptDate(bits[7]));

      // <snip>other modifiers go here</snip>

      current.setTrackCount(Integer.parseInt(bits[21]));
      current.setTrackNumber(Integer.parseInt(bits[22]));
      current.setYear(Integer.parseInt(bits[23]));
      current.setName(bits[24]);

      return current;

   // if the script doesn't execute properly, then throw
   // an exception to propagate the error
   } catch (Exception e) {
      throw new AppleScriptException(e);
   }
}

It should be noted that our solution does require more code than would be required if Apple's NS* Java classes worked as intended. But, oddly enough, the extra code is AppleScript, not Java, due to the process of manually flattening AppleScript objects into a single string rather than using an NSAppleEventDescriptor to contain the object's individual fields. While it is by no means an elegant solution, it gets the job done reliably and proves to be an interesting exercise in making the different faces of OS X talk to each other in ways that weren't originally intended.

Wrapping Up

Mac OS X has proven to be a healthy and productive platform for developers, and given Apple's recent track record there are no signs that this situation will change in the near future. However, with all of the new technical demos shown in Tiger's previews intended for Objective-C, one hopes that Java developers will also have something to play with upon booting up Apple's new operating system. Or, if not something new, then at least a working copy of what was promised years ago when the first version of OS X was being previewed to developers years ago.

About the Code

The class and supporting JAR files can be found on the CD, which also includes an ANT build file to take care of the heavy lifting; see the accompanying documentation for more information on how to build the class. There are several classes used in the above listing that are free to download and use:

  • AppleScript.java and AppleScriptException.java are part of the com.fivevoltlogic.tools.orchard package,
  • And Track.java is part of the com.fivevoltlogic.mytunes package.

Copies are included on the CD and can also be downloaded from http://www.fivevoltlogic.com/code/.


David Miller is a developer based in Calgary, AB, Canada. You can reach him by sending an email to davidfmiller@gmail.com or pointing your browser to http://www.fivevoltlogic.com.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Apple Remote Desktop 3.8 - Remotely cont...
Apple Remote Desktop is the best way to manage the Mac computers on your network. Distribute software, provide real-time online help to end users, create detailed software and hardware reports, and... Read more
NeoOffice 2014.7 - Mac-tailored, OpenOff...
NeoOffice is a complete office suite for OS X. With NeoOffice, users can view, edit, and save OpenOffice documents, PDF files, and most Microsoft Word, Excel, and PowerPoint documents. NeoOffice 3.x... Read more
DesktopLyrics 2.6.6 - Displays current i...
DesktopLyrics is an application that displays the lyrics of the song currently playing in "iTunes" right on your desktop. The lyrics for the song have to be set in iTunes; DesktopLyrics does nothing... Read more
Ember 1.8.3 - Versatile digital scrapboo...
Ember (formerly LittleSnapper) is your digital scrapbook of things that inspire you: websites, photos, apps or other things. Just drag in images that you want to keep, organize them into relevant... Read more
Apple iTunes 12.1 - Manage your music, m...
Apple iTunes lets you organize and play digital music and video on your computer. It can automatically download new music, app, and book purchases across all your devices and computers. And it's a... Read more
LibreOffice 4.4.3 - Free, open-source of...
LibreOffice is an office suite (word processor, spreadsheet, presentations, drawing tool) compatible with other major office suites. The Document Foundation is coordinating development and... Read more
FoldersSynchronizer 4.2.1 - Synchronize...
FoldersSynchronizer is a popular and useful utility that synchronizes and backs-up files, folders, disks and boot disks. On each session you can apply special options like Timers, Multiple Folders,... Read more
Simon 4.0.2 - Monitor changes and crashe...
Simon monitors websites and alerts you of crashes and changes. Select pages to monitor, choose your alert options, and customize your settings. Simon does the rest. Keep a watchful eye on your... Read more
Cocktail 8.1.2 - General maintenance and...
Cocktail is a general purpose utility for OS X that lets you clean, repair and optimize your Mac. It is a powerful digital toolset that helps hundreds of thousands of Mac users around the world get... Read more
Cyberduck 4.6.4 - FTP and SFTP browser....
Cyberduck is a robust FTP/FTP-TLS/SFTP browser for the Mac whose lack of visual clutter and cleverly intuitive features make it easy to use. Support for external editors and system technologies such... Read more

Playworld Superheroes Review
Playworld Superheroes Review By Tre Lawrence on January 30th, 2015 Our Rating: :: HERO CRAFTINGUniversal App - Designed for iPhone and iPad It’s all about the imagination, fighting bad creatures — and looking good while doing so.   | Read more »
Join the SpongeBob Bubble Party in this...
Join the SpongeBob Bubble Party in this New Match 3 Bubble Poppin’ Frenzy Posted by Jessica Fisher on January 30th, 2015 [ permalink ] | Read more »
Handpick Review
Handpick Review By Jennifer Allen on January 30th, 2015 Our Rating: :: TANTALIZING SUGGESTIONSiPhone App - Designed for the iPhone, compatible with the iPad Handpick will make you hungry, as well as inspire you to cook something... | Read more »
Storm the Halls of Echo Base in First St...
Storm the Halls of Echo Base in First Star Wars: Galactic Defense Event Posted by Jessica Fisher on January 30th, 2015 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Contradiction Review
Contradiction Review By Tre Lawrence on January 30th, 2015 Our Rating: :: SPOT THE LIEiPad Only App - Designed for the iPad Contradiction is a live action point and click adventure that’s pretty engaging.   Developer: Tim Follin... | Read more »
Unlock Sunshine Girl in Ironkill with th...
Unlock Sunshine Girl in Ironkill with this special 148Apps code Posted by Rob Rich on January 29th, 2015 [ permalink ] Robo-fighter Ironkill has been out on iOS a | Read more »
Crossroad Zombies Review
Crossroad Zombies Review By Jordan Minor on January 29th, 2015 Our Rating: :: CROSSWALKING DEADiPad Only App - Designed for the iPad Crossroad Zombies is a rough draft of a cool genre mash-up.   | Read more »
Blood Brothers 2 – Tips, Cheats, and Str...
War is hell: Is it the kind of hell you want to check out? Read our Blood Brothers 2 review to find out! Blood Brothers 2, DeNA’s follow-up to the original Blood Brothers, is an intriguing card collecting / role-playing / strategy hybrid. There’s... | Read more »
Blood Brothers 2 Review
Blood Brothers 2 Review By Nadia Oxford on January 29th, 2015 Our Rating: :: AN AGGRAVATING RELATIVEUniversal App - Designed for iPhone and iPad Blood Brothers 2 is built on a simple, solid foundation, but its free-to-play system... | Read more »
I AM BREAD, the Toast of the Town, is Ro...
Have you ever dreamt of being deliciously gluten-y? Do you feel passionate about Rye and Wheat? The guys at Bossa Studios do and that is why they are bringing I AM BREAD to iOS soon. The loafy app will feature all the new content that is being... | Read more »

Price Scanner via MacPrices.net

Amazon offers 15-inch 2.2GHz Retina MacBook P...
 Amazon.com has the 15″ 2.2GHz Retina MacBook Pro on sale for $1879 including free shipping. Their price is $120 off MSRP, and it’s the lowest price available for this model from any reseller (except... Read more
Intel Aims to Transform Workplace With 5th-Ge...
Intel Corporation today announced the availability of its 5th generation Intel Core vPro processor family that provides cutting-edge features to enable a new and rapidly shifting workplace. To meet... Read more
iOS App Sharalike Introduces New Instant Smar...
Sharalike slideshow and photo management software for iOS, is making it easier than ever to create shareable meaningful moments with its new instant SmartShow technology. Staying organized is a goal... Read more
Apple Becomes World’s Largest Smartphone Vend...
According to the latest research data from Strategy Analytics, as global smartphone shipments grew 31 percent annually to reach a record 380 million units in the fourth quarter of 2014. Apple became... Read more
Cut the Cord: OtterBox Resurgence Power Case...
Dead batteries and broken phones are two of the biggest issues for smartphone users today. Otterbox addresses both with the new Resurgence Power Case for Apple iPhone 6, promising to make those panic... Read more
13-inch Retina MacBook Pros on sale for up to...
B&H Photo has 13″ Retina MacBook Pros on sale for $200 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 2.6GHz/128GB Retina MacBook Pro: $1199.99 save $100 - 13″ 2.6GHz/... Read more
15-inch 2.5GHz Retina MacBook Pro on sale for...
 B&H Photo has the 15″ 2.5GHz Retina MacBook Pro on sale for $2319.99 including free shipping plus NY sales tax only. Their price is $180 off MSRP, and it’s the lowest price available for this... Read more
Back in stock: Refurbished iPod nanos for $99...
The Apple Store has Apple Certified Refurbished 16GB iPod nanos available for $99 including free shipping and Apple’s standard one-year warranty. That’s $50 off the cost of new nanos. Most colors are... Read more
Apple lowers price on refurbished 256GB MacBo...
The Apple Store has lowered prices on Apple Certified Refurbished 2014 MacBook Airs with 256GB SSDs, now available for up to $200 off the cost of new models. An Apple one-year warranty is included... Read more
New Good Management Suite Simplifies Enterpri...
Good Technology has announced the availability of the Good Management Suite, a comprehensive cross-platform solution for organizations getting started with mobile business initiatives. Built on the... Read more

Jobs Board

At-Home Chat Specialist- *Apple* Online Stor...
**Job Summary** At Apple , we believe in hard work, a fun environment, and the kind of creativity and innovation that only comes about when talented people from diverse Read more
Sr. Mac Expert- *Apple* Online Store - Apple...
**Job Summary** The World Wide Apple Online Store (AOS) Sales and Service team is looking for motivated, outgoing, and tech savvy individuals who want to offer Apple Read more
*Apple* Solutions Consultant- Retail Sales (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
Event Director, *Apple* Retail Marketing -...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global engagement strategy and team. Delivering an overarching brand Read more
At-Home Chat Specialist- *Apple* Online Stor...
**Job Summary** At Apple , we believe in hard work, a fun environment, and the kind of creativity and innovation that only comes about when talented people from diverse Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.