8d2abbe1816fdc45caffdb9ba39ff96cff85816a
[metze/wireshark/wip.git] / packaging / macosx / osx-dmg.sh.in
1 #!/bin/bash
2 #
3 # $Id$
4 #
5 # USAGE
6 # osx-dmg [-s] -p /path/to/Wireshark.app
7 #
8 # The script creates a read-write disk image,
9 # copies Wireshark into it, customizes its appearance using a
10 # previously created .DS_Store file (wireshark.ds_store),
11 # and then compresses the disk image for distribution.
12 #
13 # Copied from Inkscape.
14 #
15 # AUTHORS
16 #       Jean-Olivier Irisson <jo.irisson@gmail.com>
17 #       Michael Wybrow <mjwybrow@users.sourceforge.net>
18 #
19 # Copyright (C) 2006-2007
20 # Released under GNU GPL, read the file 'COPYING' for more information
21 #
22 #
23 # How to update the disk image layout:
24 # ------------------------------------
25 #
26 # Modify the 'dmg_background.svg' file and generate a new
27 # 'dmg_background.png' file.
28 #
29 # Update the AppleScript file 'dmg_set_style.scpt'.
30 #
31 # Run this script with the '-s' option.  It will apply the
32 # 'dmg_set_style.scpt' AppleScript file, and then prompt the
33 # user to check the window size and position before writing
34 # a new 'wireshark.ds_store' file to work around a bug in Finder
35 # and AppleScript.  The updated 'wireshark.ds_store' will need
36 # to be commited to the repository when this is done.
37 #
38
39 # Defaults
40 set_ds_store=false
41 ds_store_root="root.ds_store"
42 app_bundle="Wireshark.app"
43 rw_name="RWwireshark.dmg"
44 volume_name="Wireshark"
45 tmp_dir="/tmp/dmg-$$"
46 auto_open_opt=
47 utilities="Utilities"
48 ws_bin="$app_bundle/Contents/Resources/bin/wireshark-bin"
49
50 if [ -d /Applications/Xcode.app/Developer ]
51 then
52         developer_path=/Applications/Xcode.app/Developer
53 elif [ -d /Developer ]
54 then
55         developer_path=/Developer
56 fi
57 if [ ! -z $developer_path ]
58 then
59         PATH=$PATH:$developer_path/Tools:$developer_path/usr/bin
60 fi
61
62 # Help message
63 #----------------------------------------------------------
64 help()
65 {
66 echo -e "
67 Create a custom dmg file to distribute Wireshark
68
69 USAGE
70         $0 [-s] -p /path/to/Wireshark.app
71
72 OPTIONS
73         -h,--help
74                 display this help message
75         -s
76                 set a new apperance (do not actually create a bundle)
77         -b,--app-bundle
78                 set the path to the Wireshark.app that should be copied
79                 in the dmg
80 "
81 }
82
83 # Parse command line arguments
84 while [ "$1" != "" ]
85 do
86         case $1 in
87                 -h|--help)
88                         help
89                         exit 0 ;;
90                 -s)
91                         set_ds_store=true ;;
92                 -b|--app-bundle)
93                         app_bundle="$2"
94                         shift 1 ;;
95                 *)
96                         echo "Invalid command line option"
97                         exit 2 ;;
98         esac
99         shift 1
100 done
101
102 # Safety checks
103 if [ ! -e "$app_bundle" ]; then
104         echo "Cannot find application bundle: $app_bundle"
105         exit 1
106 fi
107
108 # Safety checks
109 if [ ! -e "$utilities" ]; then
110         echo "Cannot find utilities: $utilities"
111         exit 1
112 fi
113
114 # Get the architecture
115 case `file $ws_bin` in
116         *Mach-O*64-bit*x86_64*)
117                 architecture="Intel 64"
118                 ;;
119         *Mach-O*i386*)
120                 architecture="Intel 32"
121                 ;;
122         *Mach-O*ppc64*)
123                 architecture="PPC 64"
124                 ;;
125         *Mach-O*ppc*)
126                 architecture="PPC 32"
127                 ;;
128         *)
129                 echo "Cannot determine architecture"
130                 exit 1
131                 ;;
132 esac
133
134 # Set the version
135 version="@VERSION@"
136 if [ -z "$version" ] ; then
137         echo "VERSION not set"
138         exit 1
139 fi
140
141 echo -e "\nCREATE WIRESHARK PACKAGE\n"
142 pkg_title="$volume_name $version $architecture"
143 pkg_file="$pkg_title.pkg"
144 rm -rf "$pkg_file"
145 packagemaker --doc "Wireshark_package.pmdoc" \
146     --title "$pkg_title" \
147     --version "$version" \
148     --verbose || exit 1
149
150 echo -e "\nCREATE WIRESHARK DISK IMAGE\n"
151 img_name="$pkg_title.dmg"
152
153 # Create temp directory with desired contents of the release volume.
154 rm -rf "$tmp_dir"
155 mkdir "$tmp_dir" || exit 1
156
157 echo -e "Copying files to temp directory"
158 # Wireshark itself
159 # Copy Wireshark.app
160 cp -rf "$pkg_file" "$tmp_dir"/ || exit 1
161 # Link to Applications in order to drag and drop wireshark onto it
162 #ln -sf /Applications "$tmp_dir"/
163 # Copy the utilites
164 #cp -rf "$utilities" "$tmp_dir"/
165 #ln -sf /Library/StartupItems "$tmp_dir/$utilities"/
166 # Copy the readme
167 cp -rf  Read_me_first.rtf "$tmp_dir"/"Read me first.rtf" || exit 1
168
169 # If the appearance settings are not to be modified we just copy them
170 if [ ${set_ds_store} = "false" ]; then
171         # Copy the .DS_Store file which contains information about
172         # window size, appearance, etc.  Most of this can be set
173         # with Apple script but involves user intervention so we
174         # just keep a copy of the correct settings and use that instead.
175         cp $ds_store_root "$tmp_dir/.DS_Store" || exit 1
176         auto_open_opt=-noautoopen
177 fi
178
179 # Create a new RW image from the temp directory.
180 echo -e "Creating a temporary disk image"
181 rm -f "$rw_name"
182 /usr/bin/hdiutil create -srcfolder "$tmp_dir" -volname "$volume_name" -fs HFS+ -fsargs "-c c=64,a=16,e=16" -format UDRW "$rw_name" || exit 1
183
184 # We're finished with the temp directory, remove it.
185 rm -rf "$tmp_dir"
186
187 # Mount the created image.
188 MOUNT_DIR="/Volumes/$volume_name"
189 DEV_NAME=`/usr/bin/hdiutil attach -readwrite -noverify $auto_open_opt  "$rw_name" | egrep '^/dev/' | sed 1q | awk '{print $1}'`
190
191 # Have the disk image window open automatically when mounted.
192 bless -openfolder /Volumes/$volume_name
193
194 # In case the apperance has to be modified, mount the image and apply the base settings to it via Applescript
195 if [ ${set_ds_store} = "true" ]; then
196         /usr/bin/osascript dmg_set_style.scpt
197
198         open "/Volumes/$volume_name"
199         # BUG: one needs to move and close the window manually for the
200         # changes in appearance to be retained...
201         echo "
202         **************************************
203         *  Please move the disk image window *
204         *    to the center of the screen     *
205         *   then close it and press enter    *
206         **************************************
207         "
208         read -e DUMB
209
210         # .DS_Store files aren't written till the disk is unmounted, or finder is restarted.
211         hdiutil detach "$DEV_NAME"
212         auto_open_opt=-noautoopen
213         DEV_NAME=`/usr/bin/hdiutil attach -readwrite -noverify $auto_open_opt  "$rw_name" | egrep '^/dev/' | sed 1q | awk '{print $1}'`
214         echo
215         cp /Volumes/$volume_name/.DS_Store ./$ds_store_root
216         SetFile -a v ./$ds_store_root
217         echo "New $ds_store_root written. Re-run $0 without the -s option to use them"
218
219         # Unmount the disk image.
220         hdiutil detach "$DEV_NAME"
221         rm -f "$rw_name"
222
223         exit 0
224 fi
225
226 # Unmount the disk image.
227 hdiutil detach "$DEV_NAME"
228
229 # Create the offical release image by compressing the RW one.
230 echo -e "Compressing the final disk image"
231
232 # TODO make this a command line option
233 if [ -e "$img_name" ]; then
234         echo "$img_name already exists."
235         rm -i "$img_name"
236 fi
237 /usr/bin/hdiutil convert "$rw_name" -format UDZO -imagekey zlib-level=9 -o "$img_name" || exit 1
238 rm -f "$rw_name"
239
240 exit 0