TweetFollow Us on Twitter

Back to bash Basics

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

Mac in the Shell

Back to bash Basics: Following Up on the bash Presented Thus Far

by Edward Marczak

Carpenters shape wood. Fletchers shape arrows. Programmers shape code. So far, we've been apprentices in the mastery of bash scripting. This month, we'll take another step up that ladder, and learn how to make our code flow. In the ever-blurring distinction between programming and scripting, let's look at some of the bash shell's better programming conventions and statements.

Too smart for me

I'm going to make several assumptions this month. Namely:

  • You know how to turn on a computer
  • You've been following my column for a little bit
  • You know what variables are
  • You're smart, and have been around this stuff for at least a little bit
  • You've seen some kind of flow control statements in some language, somewhere

Not too rough, right? Good. Let's go.

Why are you beating me?

Since bash is built-in to every OS X box, present and ready-to-go, it's a great tool for small, quick and dirty scripts, to more complex and full-featured (dare I say?) applications. While "application" may be a stretch, for any code to approach that, it has to be able to make decisions. The scripting 'techniques' presented thus far have really been pouring the foundation, which is important, but have really been little more than stringing commands together sequentially. Fine for basic automation, but limited in the grand scheme of things.

We need a way to introduce flow control into our code. This is a basic concept in all programming languages. Flow control is the classic, "if some condition exists, then follow these instructions." Or, "perform this set of statements x number of times." Of course, the syntax tends to be a little different between each language, and bash won't let you down. First, here's what bash gives us:

  • if/else
  • while/until
  • for
  • case
  • select

Why are you beating me?

if/else is about as basic as it gets. When you need to decide if your code should, or should not do something, you use if/else. You've probably seen this before - even Excel's VBA has if tests! Here's where bash is different: most languages test for some true Boolean condition. bash's if tests exit codes. That's it. Lodge that in your brain and you'll save yourself grief later on.

Every Unix program returns a code, in the form of an integer in the range 0-255, to its parent process when it quits - the exit code. Here's where your brain may spin: 0 is (typically) the "OK" code, meaning success. So, in an if statement, an exit code of "0" means, "true, run this code." However, this is a de facto standard, and the meanings of exit codes are up to the programmer.

A better way to think of this is that of "exit success." So:


if some command was successful
then
do this bit of code
else
yell and scream
fi

bash uses the variable "?" to store exit status of the most recently run program. To illustrate, follow this example:

$ touch example.txt
$ echo $?
0
$ grep asdf example.txt
$ echo $?
1

"?" shows the exit codes. "touch example.txt" was successful; it returned a "0" exit code. grep, however, couldn't find the string "asdf" in example.txt, so it was unsuccessful, and handed us back a "1" exit code. Of course, we can use this in a script.

ping, like most utilities, will hand us back a "0" on success, and some value greater than zero if there's a problem. Here's a cheap-o host monitor script:

#!/bin/bash

if ping -c 1 4.2.2.2
then
   logger -i -t pingscript Ping success
else
   mail -s "Can't ping 4.2.2.2" support@example.com < pingerror.txt
   pagetech.sh
fi

We try to ping a host at 4.2.2.2 (and if you're connected to the net, this should work). If the ping succeeds, we simply make a note of it. If the ping fails, we send mail to alert us to that fact, and run another script that pages a tech.

We can also test two conditions at a time with the "&&" (and) and "||" (or) operators. If we needed two pings to different hosts to succeed, we could use "&&". Changing our if line to read:

if ping 130.57.4.27 && ping 4.4.4.2 

will run the first statement. Only if it succeeds do we even try the second. Both the first and the second statement must succeed to enter the "then" section of the if statement. You can do something similar outside of a script:

copyfile.sh && alterfile.sh && ftpfile.sh 

This example will run three scripts in succession. The next in the series will only run if the previous script exited with a successful exit code.

The "||" operator runs the first statement, if it succeeds, statement 2 never runs, and we enter the then clause. If statement 1 fails, statement 2 does run. If it succeeds, we enter the then clause. Either statement's success will get us into the then clause. Consider revising our example:

if ping 130.57.4.27 || ping 4.2.2.2

Perhaps we're just trying to see if this machine is connected to the Internet. Say host 130.57.4.27 goes down. As long as we can still ping 4.4.4.2, this script doesn't send mail to us, or try to page someone.

if/then may be basic, but just this simple decision scheme alone can create powerful scripts. Let's make it more so. if/then is powerful, but testing exit codes alone can get tedious. The shell provides the test command to test various conditions. To make the command more concise and visually pleasing, [ is aliased to test. So this:

if test -e /bin/bash

is the same as this:

if [ -e /bin/bash ]

Most people use the [...] variant. I will do the same. When I say, "test", I'm referring to test or [. What can test check for us? The man page is of great use here, but I'll give an example or two:

File tests:

-e test for a file's existence, no matter the type.

-d test for a directory

String comparisons:

s1 = s2 string 1 is equal to string 2.

-n string is not null

Integer comparisons:

-lt less than

-eq equal

-ne not equal

Other notes for inside the brackets: you can use "!" to negate a test:

if [ ! -e ~/secretplans.txt ]

"And" and "or" are available within the brackets:

and: if [ -e /bin/bash -a -e /bin/false ]

or: if [ -e /bin/bash -o -e /bin/tcsh ]

...and don't forget that all of this can be combined:

if [ ! -d /Users/Shared/reports -o ! -e /nightly/`date +%Y%m%d`.txt ] 
   && rsync -delete -av -e ssh repuser@host.example.com:reports/* /Users/Shared/reports ; then
logger -t repsync Reports are current
else
logger -t repsync Reports are out of sync/missing
fi

Whew! That is:

If the "reports" directory or the nightly file doesn't exist, we try to rsync them. If that goes well, success all around. If the directory or file do exist, we're done. If the rsync fails, we note it in the system log. That packs a lot in a single "if" statement.

Why are you beating me?

If you're an old Pascal or C hand, you'll recognize these two constructs: while and until. For the uninitiated, while repeats a block of statements for the duration of a condition being true. until runs a block of code until a condition is met. One look at them in action, and you'll get it:

while [ -e /run/statusflag.txt ]
do
   copyfiles.sh
   sleep 300
done

The until block is very similar:

until [ -e thecowscomehome.txt ]
do
   jump_over_moon.sh
done

Easy, right? Naturally, you can run all of the tests that the if statement allows.

Why are you beating me?

Sometimes, either you or a variable know how many times a loop should run. (Does that make anyone else think of Tron?). The constructs of for and forelse allow us to do just this. This is where you'll see a lot of difference from traditional languages. While you can pull off those kinds of loops:

#!/bin/bash
for ((i=1;i<=10;i+=1))
do        
        echo $i
done

...you'll very rarely see that done in practice. What happens to be much cooler than this, though, is the ability to loop through file lists, directories and command line arguments passed to your script. This is truly, as the kids say, da bomb. Look at this simple example:

#!/bin/bash

for i in "*.sh"
do
        echo $i
done

This script gives me something like this:

$ ./loopy.sh 
backup.sh createdmg.sh fctest.sh it.sh loopy.sh speakdate.sh spread.sh syncsm.sh

Well, gosh, I could have simply used the one-line echo *.sh to achieve the same thing. How about something that gives us info on each file? Line by line output can be achieved in a few different ways, but here's the way I'm choosing, for the moment:

#!/bin/bash

FILES=`ls *.sh`

for i in $FILES
do
        echo $i
        if [ -O $i ]; then
                echo "You own $i."
        fi
        if [ -G $i ]; then
                echo "You are a group owner of $i."
        fi
        echo
done

Running the above gives me something akin to this:

$ ./loopy2.sh 
backup.sh
You own backup.sh.
You are a group owner of backup.sh.

createdmg.sh
You own createdmg.sh.

fctest.sh
You own fctest.sh.

it.sh
You own it.sh.

Loopy2.sh
You own loopy.sh.
You are a group owner of loopy2.sh

As mentioned, for is a fantastic way for dealing with arguments passed into the script. Here's a slightly contrived example that will make a directory and copy the files and/or types (based on extension) into that directory. The new concept here are the parameter variables: @ and #. "$@" contains a list of each positional parameter, $1, $2...$N that is passed into the script. "$#" contains the number of parameters passed in. We can even include a little error correction this way:

#!/bin/bash

thedir=`date +%Y%m%d`

if [ $# -gt 0 ]; then
        mkdir $thedir
        for list in "$@"; do
                cp $list $thedir
        done
else
        echo "usage: $0 (files)"
fi

Fun and functional! Right?

Why are you beating me?

The last flow control statements we'll cover this month, case and select, bring their own power to bash, much like the previous flow control variants.

case is a neat alternative to a bevy of if/then/else statements. You immediately know the reason for this if you've used "case" in Pascal, or "switch" in C. If you've never seen those, one example and you'll be a pro:

#!/bin/bash

freespace=`df / | tail -1 | awk '{print $5}' | cut -d "%" -f1`

case $freespace in
[1-6]*) report="Plenty of room on /"
;;
[7-8]*) report="You might want to fire up du and take a look at /, it is $freespace percent full."
;;
9[0-9]) report="Can you order a bigger disk and overnight it?  / is at $freespace percent!"
;;
*) report="I can't determine the amount of space on /"
;;
esac

echo $report

Of course, the power in the bash version lies in its ability to process patterns and command-line arguments:

#!/bin/bash

for file in $*; do
case $file in
*.txt) echo "$file is a text file."
;;
*.pl) echo "$file is a perl file."
;;
*.sh) echo "$file is a shell script."
;;
*.gif | *.png | *.jpg | *.jpeg | *.tiff) what=`sips -g format $file | tail -1`
        echo "$file is a $what"
        sizeh=`sips -g pixelHeight $file | tail -1`
        sizew=`sips -g pixelWidth $file | tail -1`
        echo "It is $sizew x $sizeh"
;;
*.aiff | *.sd2 | *.wav | *.mp3) echo "$file is some kind of audio file."
;;
*) echo "Sorry, I don't know what kind of file $file is!"
esac

done

Save this in a new file, make it executable and pass it some files you want information about. I really think the way you can process multiple options on one line is really elegant.

select is really its own unique construct. It will take the list of items passed to it, create a numbered menu out of those lists and wait for input. Watch it in action (file gives us information about a file, as seen on line 5):

#!/bin/bash

select theItem; do
        if [ $theItem ]; then
                file $theItem
                break
        fi
done

With no in clause (select variable in list), select defaults to the list of command-line parameters. So, when we run this example, we need to pass in the list to process:

$ ./st.sh *
1) printaudit.pl
2) BidToJob.dmg
3) cl.txt
4) list.txt
5) loopy.sh
#?

Pressing "2", followed by enter, has the program output:

BidToJob.dmg: Macintosh HFS Extended version 4 data last 
mounted by: '10.0', created:Tue Dec  7 16:58:10 2004, last 
modified: Wed Jan  5 18:07:44 2005, last checked: Tue Dec  7 
16:58:10 2004, block size: 4096, number of blocks: 1024, 
free blocks: 727

A bit Spartan, perhaps, but certainly functional, and will save you a ton of work. Again, the power here lies in being able to build menus, completely ad-hoc, based on the contents of a directory.

It's all about your style

Next month, we'll get a little deeper into why some of the above works, as we probe deeper into the bowels of bash. Also, we'll expand on other loop constructs. Like any programming, there's typically more than one way to achieve the same thing. You can avoid all use of until by negating a while loop. You can split up lists with bash's processing, grep, sed, cut, and other utilities. I can only serve as a guide. Practice, err, correct; then the apprentice becomes the master.


Ed Marczak, owns and operates Radiotope, a technology consulting company that specializes in networking, workflow automation, teaching about technology, and helping out. Tech relief at http://www.radiotope.com

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

DiskCatalogMaker 7.2.7 - Catalog your di...
DiskCatalogMaker is a simple disk management tool which catalogs disks. Simple, light-weight, and fast Finder-like intuitive look and feel Super-fast search algorithm Can compress catalog data for... Read more
Iridient Developer 3.2.1 - Powerful imag...
Iridient Developer (was RAW Developer) is a powerful image-conversion application designed specifically for OS X. Iridient Developer gives advanced photographers total control over every aspect of... Read more
BusyContacts 1.2.7 - Fast, efficient con...
BusyContacts is a contact manager for OS X that makes creating, finding, and managing contacts faster and more efficient. It brings to contact management the same power, flexibility, and sharing... Read more
MegaSeg 6.0.5 - Professional DJ and radi...
MegaSeg is a complete solution for pro audio/video DJ mixing, radio automation, and music scheduling with rock-solid performance and an easy-to-use design. Mix with visual waveforms and Magic... Read more
BusyContacts 1.2.7 - Fast, efficient con...
BusyContacts is a contact manager for OS X that makes creating, finding, and managing contacts faster and more efficient. It brings to contact management the same power, flexibility, and sharing... Read more
MegaSeg 6.0.5 - Professional DJ and radi...
MegaSeg is a complete solution for pro audio/video DJ mixing, radio automation, and music scheduling with rock-solid performance and an easy-to-use design. Mix with visual waveforms and Magic... Read more
Iridient Developer 3.2.1 - Powerful imag...
Iridient Developer (was RAW Developer) is a powerful image-conversion application designed specifically for OS X. Iridient Developer gives advanced photographers total control over every aspect of... Read more
iFFmpeg 6.6.1 - Convert multimedia files...
iFFmpeg is a comprehensive media tool to convert movie, audio and media files between formats. The FFmpeg command line instructions can be very hard to master/understand, so iFFmpeg does all the hard... Read more
Tor Browser Bundle 7.0.11 - Anonymize We...
The Tor Browser Bundle is an easy-to-use portable package of Tor, Vidalia, Torbutton, and a Firefox fork preconfigured to work together out of the box. It contains a modified copy of Firefox that... Read more
iShowU Instant 1.2.4 - Full-featured scr...
iShowU Instant gives you real-time screen recording like you've never seen before! It is the fastest, most feature-filled real-time screen capture tool from shinywhitebox yet. All of the features you... Read more

Latest Forum Discussions

See All

Reigns: Her Majesty guide - how to use e...
Ruling a kingdom isn't easy--doubly so for a queen whose every decision is questioned by the other factions seeking a slice of power. Reigns: Her Majesty builds on the original game's swipey tactics, adding items that you can use to move the story... | Read more »
The best new games we played this week -...
Friday has crept up on us once again, so it's time to honor the best new games we've played over the past few days. This past week was a pretty exciting one, with the debut of lots of beautiful new indies and some familiar faces returning to the... | Read more »
Portal Knights guide- beginner tips and...
Portal Knights is finally making the jump to iOS and Android, and it's already climbing the ranks to become the next big MMO experience on mobile. This sprawling sandbox game will let you pursue any adventure you wish, whether you want to sling... | Read more »
Reigns: Her Majesty guide - how to swipe...
Reigns: Her Majesty is storming the App Store this week, bringing more tinder-esque kingdom building to eager players everywhere. If you've played the original Reigns, you'll know that leading a kingdom is never easy. It's a careful balancing act... | Read more »
Getting Over It (Games)
Getting Over It 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: A game I madeFor a certain kind of person To hurt them. • Climb up an enormous mountain with nothing but a hammer and a pot.•... | Read more »
Reigns: Her Majesty (Games)
Reigns: Her Majesty 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: | Read more »
Pocket Legends Adventures guide - how to...
Pocket Legends Adventures is a fun action adventure RPG that takes control when you want it to, but also opens itself for player input, too, if you're looking to tkae a more active role in combat. Regardless of play style, the game can be quite... | Read more »
Portal Knights (Games)
Portal Knights 1.2.4 Device: iOS Universal Category: Games Price: $4.99, Version: 1.2.4 (iTunes) Description: Craft your adventure. Forge your hero. Become the ultimate Portal Knight! | Read more »
Ashworld (Games)
Ashworld 1.3 Device: iOS Universal Category: Games Price: $3.99, Version: 1.3 (iTunes) Description: | Read more »
The best deals on the App Store this wee...
Another week means another roundup of quality bargain games. This week's list features a few games we haven't featured before in our weekly roundups. If you're on the prowl for new games, now's an optimal time to try something completely new for... | Read more »

Price Scanner via MacPrices.net

Beats by Dr. Dre – BeatsX Earphones on sale f...
Best Buy has BeatsX Earphones on sale for $109, $40 off, on their online store. Sale price for online orders only. Choose free store pickup, if available, or choose free shipping. Read more
10″ 64GB WiFi Apple iPad Pros on sale for $59...
MacMall has 10.5″ 64GB Apple iPad Pros on sale for $599 including free shipping. That’s $50 off MSRP and among the lowest prices available for these iPads from any Apple reseller. Read more
15″ 2.2GHz MacBook Pros on sale for $200-$300...
B&H Photo has the 15″ 2.2GHz MacBook Pro available for $200 off MSRP including free shipping plus NY & NJ sales tax only: – 15″ 2.2GHz MacBook Pro (MJLQ2LL/A): $1799 $200 off MSRP Apple has... Read more
Holiday sale: 15″ MacBook Pros for $200-$420...
MacMall has 15″ MacBook Pros on sale for $220-$300 off MSRP, each including free shipping: – 15″ 2.8GHz MacBook Pro Space Gray (MPTR2LL/A): $2179, $220 off MSRP – 15″ 2.8GHz MacBook Pro Silver (... Read more
Holiday sale: 13″ MacBook Airs for up to $150...
B&H Photo has 13″ MacBook Airs on sale for $100 off MSRP as part of their Holiday sale. Shipping is free, and B&H charges sales tax for NY & NJ residents only: – 13″ 1.8GHz/128GB MacBook... Read more
The best Holiday sale prices on 13″ MacBook P...
B&H Photo has 13″ MacBook Pros on sale this weekend, with models available for $100-$150 off MSRP. Shipping is free, and B&H charges sales tax for NY & NJ residents only: – 13-inch 2.3GHz... Read more
Holiday sale: 27″ Apple iMacs for $150-$200 o...
MacMall has 27″ iMacs on sale for $150-$200 off MSRP as part of their Holiday sale, each including free shipping: – 27″ 3.8GHz iMac (MNED2LL/A): $2099 $200 off MSRP – 27″ 3.5GHz iMac (MNEA2LL/A): $... Read more
Save on clearance 2016 15″ MacBook Pros, up t...
B&H Photo has clearance 2016 15″ MacBook Pros available for up to $700 off original MSRP. Shipping is free, and B&H charges NY & NJ sales tax only: – 15″ 2.7GHz Touch Bar MacBook Pro... Read more
Apple offers Certified Refurbished 9.7″ iPads...
Apple has Certified Refurbished 9.7″ WiFi iPads available for $50-$70 off the cost of new models. An Apple one-year warranty is included with each iPad, and shipping is free: – 9″ 32GB WiFi iPad: $... Read more
Save $200-$240 on a 12″ Apple MacBook with Ce...
Apple has Certified Refurbished 2017 12″ Retina MacBooks available for $200-$240 off the cost of new models. Apple will include a standard one-year warranty with each MacBook, and shipping is free.... Read more

Jobs Board

*Apple* Retail - Multiple Positions - Apple,...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Information Security - Security Data...
# Apple Information Security - Security Data Analyst Job Number: 113119545 Austin, Texas, United States Posted: 10-Nov-2017 Weekly Hours: 40.00 **Job Summary** This Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.