Zen subtheme creation automation

Hmm, Drupal's attachment system didn't like that. Okay, I'll just C&P the code.

#!/bin/bash

function show_help() {
  echo "Zenify"
  echo "by Garrett Albright"
  echo "For quickly setting up subthemes of the Zen Drupal theme."
  echo "Place at the root level of your Drupal installation. After executing,"
  echo "DELETE THIS SCRIPT! (Or at least remove execute permissions.)"
  echo ""
  echo "Usage:"
  echo "  zenify.sh subtheme_name [human_name [layout_type [site_dir]]]"
  echo "Parameters:"
  echo "  subtheme_name: The machine name of your subtheme. Should consist of"
  echo "     lower-case letters or underscores only."
  echo "  human_name: The human-friendly name of your subtheme. If it contains"
  echo "     spaces, try enclosing the name in quotes, or weird stuff may happen."
  echo "  layout_type: The layout type: fixed or liquid. Defaults to 'fixed'."
  echo "  site_dir: The name of the directory inside Drupal's 'sites' directory"
  echo "    where your site files (including themes) will be stored. The Zen"
  echo "    base theme should already be in place at /sites/site_dir/themes/zen."
  echo "    Defaults to 'all'."
  echo ""
  echo "Examples:"
  echo "  Simplest usage:"
  echo "     zenify.sh foo"
  echo "  Giving your theme a human-friendly name:"
  echo "    zenify.sh foo \"The Foo Template\""
  echo "  A friendly name and a liquid layout:"
  echo "    zenify.sh foo \"The Foo Template\" liquid"
  echo "  A friendly name and a fixed layout, but only for example.com:"
  echo "    zenify.sh foo \"The Foo Template\" fixed example.com"
  exit
}

if [ -z "$1" ] || [ "$1" = "-h" ] || [ "$1" = "--help" ]
then
  show_help
fi

if [ `echo "$1" | grep -c -e '[^[:lower:]_]'` -eq "1" ]
then
  echo "Invalid subtheme name. Subtheme names should consist only of lowercase"
  echo "letters and the underscore character."
  exit
fi

# Step 1: Create directory

dirname="`dirname $0`"

if [[ -z "$4" && -d "$dirname/sites/all/themes/zen/STARTERKIT" ]]
then
  subdir="$dirname/sites/all/themes"
else
  if [ -d "$dirname/sites/$4/themes/zen/STARTERKIT" ]
  then
    subdir="$dirname/sites/$4/themes"
  else 
    echo "Oh noes! STARTERKIT not found."
    exit
  fi
fi

cp -r "$subdir/zen/STARTERKIT" "$subdir/$1"

# Step 2: Rename and edit .info file


if [ -z "$2" ]
then
  human="$1"
else
  human="$2"
fi

sed -e "s/STARTERKIT/$1/g" -e "s/^name.*$/name        = $human/" -e "s/^description.*$/description = The $human theme \– created automatically by zenify.sh./" "$subdir/$1/STARTERKIT.info"> "$subdir/$1/$1.info"
rm "$subdir/$1/STARTERKIT.info"

# Step 3: Copy liquid or fixed stylesheet

if [ -z "$3" ]
then
  styletype="fixed"
else
  styletype="$3"
fi

cp "$subdir/zen/zen/layout-$styletype.css" "$subdir/$1/layout.css"

# Step 4: Copy print stylesheet

cp "$subdir/zen/zen/print.css" "$subdir/$1/print.css"

# Step 5: Copy Zen stylesheet. This step actually is wrong because the
# STARTERKIT directory already has a zen.css file in it. Let's rename it to the
# correct name, though.

mv "$subdir/$1/zen.css" "$subdir/$1/$1.css"

# Step 6: Change STARTERKIT in template.php and theme-settings.php.

sed -e "s/STARTERKIT/$1/g" -i ".backup" "$subdir/$1/template.php"
sed -e "s/STARTERKIT/$1/g" -i ".backup" "$subdir/$1/theme-settings.php"

rm "$subdir/$1/template.php.backup"
rm "$subdir/$1/theme-settings.php.backup"

echo "Done. PLEASE DELETE THIS SCRIPT NOW -- it's a security risk."

When it first occurred to me to automate this process, my first thought was to build it as a module; however, it would be more work that way, since you'd have to go into the admin section and activate the module, then go to a page to enter in the details (template name, human-readable name, etc) and click a Submit button, then deactivate the module (unless I got crafty and had the module automatically deactivate itself after making a theme). Running a shell script is much faster.

On the other hand, if it were a module, it would be easier to use for people unfamiliar with the command line and/or unfortunate enough to be using Windows… So maybe there's a "market" for a module version too.

Hmm. That's not a bad idea, but not a direction I personally would want to take the project. More power to you, though, if you want to do it.

Nice. Good work, Mikey.

Is your project using my shell script instead of doing the equivalent in PHP?

I'm assuming it's the latter, because your version does more than mine. But if it's the former, then… hopefully I'm stating the obvious, but… be careful when passing user-inputted values to the OS via exec() or something like that. I won't try it myself, but consider what might happen if someone tries to create a template with the name "foo; rm -rf ~" -- to use a more innocuous example.

Mikey, if I may pick a nit…

Thanks for the credit on the site, but you misspelled my first name, omitting the second T. You're hardly the first to do so and I'll bet my life you won't be the last, but, well, it is my name, so I'm a bit picky about it. Thanks.

The only thing that would make this better would be a "drag and drop" auto CSS creation interface.

What do you mean by that? Like a layout tool like Dreamweaver, or something saner?

Here's an update to the shell script to work with Beta 3. Beta 3 has us "correctly" copying zen.css again, and apparently that's the file we're supposed to hack to customize the theme. As a personal preference, though, I don't like it because it's already too crowded and messy. So the script now creates a blank CSS file named "(themename)-fresh.css" that I prefer to start hacking with. Whether you want to do the same is up to you; if not, just comment out the lines it instructs you to below. Also, the script now attempts to delete itself when it's done.

#!/bin/bash

if [ -z "$1" ] || [ "$1" = "-h" ] || [ "$1" = "--help" ]
then
  echo "Zenify"
  echo "by Garrett Albright"
  echo "For quickly setting up subthemes of the Zen Drupal theme."
  echo "Place at the root level of your Drupal installation. After executing,"
  echo "DELETE THIS SCRIPT if it did not delete itself! (Or at least remove"
  echo "execute permissions.)"
  echo ""
  echo "Usage:"
  echo "  zenify.sh subtheme_name [human_name [layout_type [site_dir]]]"
  echo "Parameters:"
  echo "  subtheme_name: The machine name of your subtheme. Should consist of"
  echo "     lower-case letters or underscores only."
  echo "  human_name: The human-friendly name of your subtheme. If it contains"
  echo "     spaces, try enclosing the name in quotes, or weird stuff may happen."
  echo "  layout_type: The layout type: fixed or liquid. Defaults to 'fixed'."
  echo "  site_dir: The name of the directory inside Drupal's 'sites' directory"
  echo "    where your site files (including themes) will be stored. The Zen"
  echo "    base theme should already be in place at /sites/site_dir/themes/zen."
  echo "    Defaults to 'all'."
  echo ""
  echo "Examples:"
  echo "  Simplest usage:"
  echo "     zenify.sh foo"
  echo "  Giving your theme a human-friendly name:"
  echo "    zenify.sh foo \"The Foo Template\""
  echo "  A friendly name and a liquid layout:"
  echo "    zenify.sh foo \"The Foo Template\" liquid"
  echo "  A friendly name and a fixed layout, but only for example.com:"
  echo "    zenify.sh foo \"The Foo Template\" fixed example.com"
  exit
fi

if [ `echo "$1" | grep -c -e '[^[:lower:]_]'` -eq "1" ]
then
  echo "Invalid subtheme name. Subtheme names should consist only of lowercase"
  echo "letters and the underscore character."
  exit
fi

# Step 1: Create directory.

dirname="`dirname $0`"

if [[ -z "$4" && -d "$dirname/sites/all/themes/zen/STARTERKIT" ]]
then
  subdir="$dirname/sites/all/themes"
else
  if [ -d "$dirname/sites/$4/themes/zen/STARTERKIT" ]
  then
    subdir="$dirname/sites/$4/themes"
  else 
    echo "Oh noes! STARTERKIT not found."
    exit
  fi
fi

cp -r "$subdir/zen/STARTERKIT" "$subdir/$1"

# Step 2: Rename and edit .info file.

if [ -z "$2" ]
then
  human="$1"
else
  human="$2"
fi

sed -e "s/STARTERKIT/$1/g" -e "s/^name.*$/name        = $human/" -e "s/^description.*$/description = The $human theme \– created automatically by zenify.sh./" "$subdir/$1/STARTERKIT.info"> "$subdir/$1/$1.info"
rm "$subdir/$1/STARTERKIT.info"

# Step 3: Copy liquid or fixed stylesheet.

if [ -z "$3" ]
then
  styletype="fixed"
else
  styletype="$3"
fi

cp "$subdir/zen/zen/layout-$styletype.css" "$subdir/$1/layout.css"

# Step 4: Copy print stylesheet.

cp "$subdir/zen/zen/print.css" "$subdir/$1/print.css"

# Step 5: Copy Zen stylesheet.

cp "$subdir/zen/zen/zen.css" "$subdir/$1/$1.css"

# This is a personal preference. Rather than hacking the ugly and crowded
# $1.css file, I prefer to start with a blank file. But it needs to be included
# by $1.css. If you don't go along with my preference, simply comment out the
# next three lines of code by prepending them with a hash mark, just as these
# lines are.

touch "$subdir/$1/$1-fresh.css"
echo "@import url(\"$1-fresh.css\");" | cat - $subdir/$1/$1.css > $subdir/$1/$1.css.temp
mv $subdir/$1/$1.css.temp $subdir/$1/$1.css

# Step 6: Change STARTERKIT in template.php and theme-settings.php.

sed -e "s/STARTERKIT/$1/g" -i ".backup" "$subdir/$1/template.php"
sed -e "s/STARTERKIT/$1/g" -i ".backup" "$subdir/$1/theme-settings.php"

rm "$subdir/$1/template.php.backup"
rm "$subdir/$1/theme-settings.php.backup"

echo "Done. The script will attempt to delete itself. Please check to make sure"
echo "that it succeeded, and if not, delete it manually. It may be a security"
echo "risk."
rm "$0"

I'd also like to see this module support multiple STARTERKITS.

What do you mean by this?

Sean, giving some thought with what you said and thinking about my own (albeit limited) experiences with creating subthemes of subthemes with Zen, I don't think it's that frequent and/or difficult of a job to warrant tweaking my script to work with it. But if you disagree, feel free to alter my script yourself. Shell scripting is fairly simple if you already know your way around a Unix command line - the hardest part for me is just trying to remember all the bajillion things sed can do.

Anyway, here's a slightly updated version which adds the "fresh" CSS file by listing it in the .info file instead of importing it from another CSS file. This is more Drupalic, though the end user won't notice the difference.

#!/bin/bash

if [ -z "$1" ] || [ "$1" = "-h" ] || [ "$1" = "--help" ]
then
  echo "Zenify"
  echo "by Garrett Albright"
  echo "For quickly setting up subthemes of the Zen Drupal theme."
  echo "Place at the root level of your Drupal installation. After executing,"
  echo "DELETE THIS SCRIPT if it did not delete itself! (Or at least remove"
  echo "execute permissions.)"
  echo ""
  echo "Usage:"
  echo "  zenify.sh subtheme_name [human_name [layout_type [site_dir]]]"
  echo "Parameters:"
  echo "  subtheme_name: The machine name of your subtheme. Should consist of"
  echo "     lower-case letters or underscores only."
  echo "  human_name: The human-friendly name of your subtheme. If it contains"
  echo "     spaces, try enclosing the name in quotes, or weird stuff may happen."
  echo "  layout_type: The layout type: fixed or liquid. Defaults to 'fixed'."
  echo "  site_dir: The name of the directory inside Drupal's 'sites' directory"
  echo "    where your site files (including themes) will be stored. The Zen"
  echo "    base theme should already be in place at /sites/site_dir/themes/zen."
  echo "    Defaults to 'all'."
  echo ""
  echo "Examples:"
  echo "  Simplest usage:"
  echo "     zenify.sh foo"
  echo "  Giving your theme a human-friendly name:"
  echo "    zenify.sh foo \"The Foo Theme\""
  echo "  A friendly name and a liquid layout:"
  echo "    zenify.sh foo \"The Foo Theme\" liquid"
  echo "  A friendly name and a fixed layout, but only for example.com:"
  echo "    zenify.sh foo \"The Foo Theme\" fixed example.com"
  exit
fi

if [ `echo "$1" | grep -c -e '[^[:lower:]_]'` -eq "1" ]
then
  echo "Invalid subtheme name. Subtheme names should consist only of lowercase"
  echo "letters and the underscore character."
  exit
fi

# Step 1: Create directory.

dirname="`dirname $0`"

if [[ -z "$4" && -d "$dirname/sites/all/themes/zen/STARTERKIT" ]]
then
  subdir="$dirname/sites/all/themes"
else
  if [ -d "$dirname/sites/$4/themes/zen/STARTERKIT" ]
  then
    subdir="$dirname/sites/$4/themes"
  else 
    echo "Oh noes! STARTERKIT not found."
    exit
  fi
fi

cp -r "$subdir/zen/STARTERKIT" "$subdir/$1"

# Step 2: Rename and edit .info file.

if [ -z "$2" ]
then
  human="$1"
else
  human="$2"
fi

sed -e "s/STARTERKIT/$1/g" -e "s/^name.*$/name        = $human/" -e "s/^description.*$/description = The $human theme \– created automatically by zenify.sh./" "$subdir/$1/STARTERKIT.info"> "$subdir/$1/$1.info"
rm "$subdir/$1/STARTERKIT.info"

# Step 3: Copy liquid or fixed stylesheet.

if [ -z "$3" ]
then
  styletype="fixed"
else
  styletype="$3"
fi

cp "$subdir/zen/zen/layout-$styletype.css" "$subdir/$1/layout.css"

# Step 4: Copy print stylesheet.

cp "$subdir/zen/zen/print.css" "$subdir/$1/print.css"

# Step 5: Copy Zen stylesheet.

cp "$subdir/zen/zen/zen.css" "$subdir/$1/$1.css"

# This is a personal preference. Rather than hacking the ugly and crowded
# $1.css file, I prefer to start with a blank file. If you don't go along with
# my preference, simply comment out the next four lines of code by prepending
# them with a hash mark, just as these lines are.

touch "$subdir/$1/$1-fresh.css"
sed -e "/stylesheets\[print\]\[\] = print.css/i\\
stylesheets[all][] = $1-fresh.css" -i ".backup" "$subdir/$1/$1.info"
rm "$subdir/$1/$1.info.backup"

# Step 6: Change STARTERKIT in template.php and theme-settings.php.

sed -e "s/STARTERKIT/$1/g" -i ".backup" "$subdir/$1/template.php"
sed -e "s/STARTERKIT/$1/g" -i ".backup" "$subdir/$1/theme-settings.php"

rm "$subdir/$1/template.php.backup"
rm "$subdir/$1/theme-settings.php.backup"

echo "Done. The script will attempt to delete itself. Please check to make sure"
echo "that it succeeded, and if not, delete it manually. It may be a security"
echo "risk."
rm "$0"

For those that might be interested, I've finally buckled and turned Zenify into a full-fledged module. Please give it a try if you can.

http://drupal.org/project/zenophile

Sure.

Thanks for the kind words, applegirl - I've quoted your review on the Zenophile project page.