Posts Tagged ‘code’

Switching Finks

One of the open-source projects I contribute to is Fink, a package manager for OS X; if you’ve used apt-get or yum on Linux, it provides a similar facility, allowing you to install, say, GnuPG by running fink install gnupg. It installs things into its own directory tree, rooted at /sw by default, to avoid interfering with things shipped by Apple (/, /usr) or manually installed by the user (/usr/local.) That is, if you have Fink installed, your system will have /sw/bin, /sw/lib, /sw/etc, /sw/share/man, &c.

So that you can run things installed in these nonstandard locations, Fink provides some shell commands in /sw/bin/init.sh which edit environment variables like PATH and MANPATH to include the /sw/* directories. Most Fink users have . /sw/bin/init.sh in their ~/.profile, so these commands will be invoked when their shell starts.

Having my shell automatically pull in Fink at startup doesn’t work for me, though. It’s important to me to have a clean environment available. For instance, when I’m contributing to non-Fink open-source projects, trying to help someone who doesn’t have Fink installed troubleshoot something, or submitting a bug report for a program that interacts with other programs where I have the Fink version installed, but Apple ships a different version with the system.1 (Note that this is only an issue if program A interacts with program B by invoking it as a standalone process without using an absolute path.2)

Also, as a Fink developer, I actually have multiple Fink installations at different paths,3 and I only want one loaded at a time; I don’t want to activate /Volumes/SandBox/fink/dev-sw in an environment where /Volumes/SandBox/fink/sw has already been pulled in!

It’s much easier to pull Fink stuff in later when I need it than to undo the changes that /sw/bin/init.sh makes to my environment. My solution for making it easy to activate a particular Fink installation was to add the following to ~/.bashrc:

  1. if [ -n "$SW" ]
  2. then export CFLAGS="-I$SW/include"
  3. export LDFLAGS="-L$SW/lib"
  4. export CXXFLAGS="$CFLAGS"
  5. export CPPFLAGS="$CXXFLAGS"
  6. export ACLOCAL_FLAGS="-I \"$SW/share/aclocal\""
  7. export PKG_CONFIG_PATH="$SW/lib/pkgconfig"
  8. export PS1="[$SW_DISPNAME \\W@$(hostname -s)]\\\$ "
  9. . "$SW/bin/init.sh"
  10. export PATH=~/bin:"$PATH"
  11. fi

What this does is arranges it so that if I start a new shell with SW and SW_DISPNAME set, it’ll pull in the Fink installation rooted at the directory $SW and put $SW_DISPNAME in my shell prompt so that I can see which environment I’m using. The extra environment variables before . $SW/bin/init.sh set things up so that if I compile things by hand, they’ll find and link against Fink-installed libraries; the PATH setting at the end is because init.sh places the Fink bin directory at the front of the PATH, and I want my personal bin directory to come before it.

I run the following script (saved as ~/bin/finkinit) when I want to pull in Fink:

  1. #!/bin/bash
  2.  
  3. FINK=${1:-main}
  4.  
  5. case "$FINK" in
  6. main)
  7. SW=/Volumes/SandBox/fink/sw
  8. SW_DISPNAME="fink"
  9. ;;
  10. dev)
  11. SW=/Volumes/SandBox/fink/dev-sw
  12. SW_DISPNAME="fink-dev"
  13. ;;
  14. *) echo "Unknown fink install '$FINK'" >&2 ; exit 1
  15. esac
  16.  
  17. export SW SW_DISPNAME
  18. exec /bin/bash

This gives me a subshell with Fink turned on, which I can exit out of when I want to return to a clean environment. If I run it as finkinit, I get my main Fink installation, or I can run finkinit dev to get an alternate Fink.


  1. Yes, this actually happens somewhat frequently. Sometimes Fink has a newer version of a program than the OS (e.g. Subversion 1.4.6 vs. 1.4.4), or sometimes the Fink version has more extensions enabled (I use Fink’s Apache because it lets me use Fink’s PHP, which in turn lets me install PHP’s MySQL extension by doing fink install php5-apache2-ssl-mysql as opposed to compiling it by hand.) 

  2. Unlike Linux, executables on Darwin have the absolute paths to their shared libraries hardcoded in the binary, so a program linked against /usr/lib/libexpat.1.dylib will always use it, even if /sw/lib/libexpat.1.dylib exists. Linux, on the other hand, uses a search path mechanism at runtime to find the libraries, similar to the way the shell figures out which program to invoke when you command it to ls

  3. At the moment, one for my personal use and a clean one for testing packages I maintain in an environment without extra packages installed. This is important for testing that you’ve declared all of the necessary dependencies. 

For All Your Finger-Pointing Needs

While working with a large codebase, I often want to find the origin of a particular line. Subversion offers a tool, annotate (aka blame, aka praise), which displays the author and revision for every line in a file, indicating who made the last change to a line. However, the last change is often not very useful; it was a minor change as a result of some other change you’re not interested in, or the code was moved around due to refactoring, and you need to go back even further.

When I need to do this, I find myself doing a sequence of:

  1. svn blame FILE | less; find the revision N where the line was last changed
  2. svn log -rN FILE | less; if the change is interesting, read the commit log for the file
  3. svn blame FILE@N-1 | less; using Subversion’s little-known pinned revision1 syntax, find the previous time the line was changed
  4. Using N-1 as the new N, return to step 2.

I’ve put together a rough version of a tool to make this easier; it’s at /trunk/blamegame in my repository, which is here for browsing with ViewVC, or it can be checked out with svn co http://zevils.com/svn/trunk/blamegame blamegame . It still needs some fine-tuning and documentation, but invoke it like blamegame FILE LINE (where FILE is a URL or the path to a file in a Subversion working copy) to start looking at a particular line of a file. You can navigate and search the file using a less-like interface. To drill down to the previous change to a line, hit r and then enter the line number. l, o, n, and m switch between viewing the commit log, the changed parts of the old file, the changed parts of the new file, and (the default) the diff. If you need to change the path you’re looking at (for instance, to jump inside a branch), use the p command. h will show the available commands.

Let me know what you think.


  1. Pretty much any Subversion command that takes a path argument can be given PATH@REVISION instead to use the version of the path at a particular revision. This is great for diff and cat as well as blame. I use it for working with deleted files and branches and diffing a branch against trunk. 

Wrong Dates in iCal Birthday Calendar

To keep track of people’s birthdays, I use Mac OS X’s1 Birthday Calendar feature of Address Book/iCal. I was going through my calendar the other day, and I noticed that a birthday which I knew was sometime in January wasn’t showing up. It was on the corresponding Address Book contact, though. I deleted the birthday from this contact and reentered it, which fixed that entry, but on the suspicion that more birthdays might be missing, I flipped through my calendar and found:2

Address Book says Mar 23, iCal says Mar 21

The Address Book birthday field has the misfeature that it forces a year to be specified.3 What a rude thing for Address Book to be asking! Anyway, I’d arbitrarily picked year 14 for the year for any contacts whose birth years I didn’t know. Maybe, I thought, the Gregorian reform was throwing things off. However, changing the year to 1900 didn’t help matters, and in fact made them worse:

Address Book says Mar 23, iCal says June 23

Turning the birthday calendar off (which wipes out iCal’s backing store for the calendar) and on didn’t help matters. A web search turned up some other people having the same problem, but the only useful solution they came up with was deleting and recreating entire contacts by hand.

I wanted to see if the raw data was wrong in Address Book’s database. Address Book uses Core Data in a way that makes the database difficult to work with at the SQLite command-line level, so instead I hacked /Developer/Examples/Python/PyObjC/AddressBook/Scripts/exportBook.py to emit the birthday field by adding ('Birthday', AddressBook.kABBirthdayProperty) to FIELD_NAMES and the following to encodeField:

    elif isinstance(value, AppKit.NSCalendarDate):
        return value.descriptionWithCalendarFormat_("%Y-%m-%d")

It turns out that a number of entries had negative years, e.g. -1900-03-23 instead of 1900-03-23. I’m not sure how this happened, but here’s a script to fix it:

  1. #!/usr/bin/python
  2. """
  3. Fix negative birthday years in Address Book.
  4. This work is hereby released into the Public Domain.
  5. """
  6. import AddressBook
  7. import AppKit
  8.  
  9. def personName(person):
  10. return "%s %s" % (
  11. person.valueForProperty_(AddressBook.kABFirstNameProperty),
  12. person.valueForProperty_(AddressBook.kABLastNameProperty)
  13. )
  14.  
  15. def formatDate(date):
  16. return date.descriptionWithCalendarFormat_("%Y-%m-%d")
  17.  
  18. def fixBirthday(birthday):
  19. year = int(birthday.descriptionWithCalendarFormat_("%Y"))
  20. if year < 0:
  21. return birthday.dateByAddingYears_months_days_hours_minutes_seconds_(
  22. -year * 2, 0, 0, 0, 0, 0)
  23. else:
  24. return None
  25.  
  26. def fixPersonBirthday(person):
  27. birthdayProp = AddressBook.kABBirthdayProperty
  28.  
  29. birthday = person.valueForProperty_(birthdayProp)
  30. if birthday == None: return
  31.  
  32. fixedBirthday = fixBirthday(birthday)
  33. if fixedBirthday != None:
  34. print "Fixing up %s: %s -> %s" % (
  35. personName(person),
  36. formatDate(birthday),
  37. formatDate(fixedBirthday)
  38. )
  39. person.setValue_forProperty_(fixedBirthday, birthdayProp)
  40.  
  41. book = AddressBook.ABAddressBook.sharedAddressBook()
  42.  
  43. for person in book.people():
  44. fixPersonBirthday(person)
  45.  
  46. book.save()

  1. 10.5.1, MacBook Pro Core 2 Duo 

  2. Names have been changed to protect the innocent. 

  3. There’s also an implementation flaw; I have my date format set to YYYY-MM-DD, and when I try to enter a year in the field, whether or not pressing a number on the keyboard will actually result in a digit appearing in the input field appears to be random. It also behaves very weirdly if there are four digits in the field already and I press another digit. I wish I could get a video of all this, but it’s not quite worth the effort of taking a screencast and a video of my fingers on the keyboard and then splice them together… 

  4. Anno Domini, not Anno Antidomini 

Migrating a wiki from Trac to MediaWiki

I’d set up a Trac installation for wedding planning, instead of using MediaWiki (the system Wikipedia uses, which I already had a couple of installations of) since we wanted both a wiki (venue data, possible honeymoon destinations, guest lists… shut up, it’s useful!) and ticket system (useful for tracking things like thank-you notes and being able to assign specific ones to either Liz or myself).

However, Dreamhost doesn’t support mod_python, so pages were taking way too long to load. I decided to switch over to MediaWiki for the wiki part and just use my existing Bugzilla installation for ticket tracking. Hence, a new script over on the code page, trac2mw. Our wiki was fairly tiny, so caveat user. I didn’t bother having it migrate tickets tickets or attachments, since we didn’t have any data there that was worth preserving. The input format, a MySQL XML dump, probably isn’t ideal for a lot of people (since Trac runs on SQLite by default.) It does fix up the wiki page syntax (the parts of it we were using, at least), though.