JAL-3394 JAL-3420 Temporary measure limits unix file extension to be the shortest...
[jalview.git] / utils / install4j / auto_file_associations-i4j8.pl
1 #!/usr/bin/env perl
2
3 use strict;
4
5 my $i4jversion = 8;
6 if ($ARGV[0] eq "-v") {
7   shift @ARGV;
8   $i4jversion = shift @ARGV;
9   die("-v i4jversion must be an integer [probably 7 or 8]") unless $i4jversion =~ m/^\d+$/;
10 }
11
12 my $fileformats = $ARGV[0];
13 $fileformats = "../../src/jalview/io/FileFormat.java" unless $fileformats;
14
15 # default mimetype will be text/x-$shortname
16 # TODO: find an actual extension for mat, see JAL-Xxxxx for outstanding issues too
17 # TODO: look up standard mime type used for BLASTfmt matrices, etc
18 my $mimetypes = {
19   rnaml => "application/rnaml+xml",
20   biojson => "application/x-jalview-biojson+json",
21   jnet => "application/x-jalview-jnet+text",
22   features => "application/x-jalview-features+text",
23   scorematrix => "application/x-jalview-scorematrix+text",
24   pdb => "chemical/x-pdb",
25   mmcif => "chemical/x-cif",
26   mmcif2 => "chemical/x-mcif",
27   jalview => "application/x-jalview+xml+zip",
28   jvl => "application/x-jalview-jvl+text",
29   annotations => "application/x-jalview-annotations+text",
30 };
31
32 my @dontaddshortname = qw(features json);
33 my @dontaddextension = qw(html xml json jar mfa fastq);
34 my $add_associations = {
35   biojson => {shortname=>"biojson",name=>"BioJSON",extensions=>["biojson"]},
36   gff2 => {shortname=>"gff2",name=>"Generic Features Format v2",extensions=>["gff2"]},
37   gff3 => {shortname=>"gff3",name=>"Generic Features Format v3",extensions=>["gff3"]},
38   features => {shortname=>"features",name=>"Jalview Features",extensions=>["features","jvfeatures"]},
39   annotations => {shortname=>"annotations",name=>"Jalview Annotations",extensions=>["annotations","jvannotations"]},
40   mmcif2 => {shortname=>"mmcif2",name=>"mmCIF",extensions=>["mcif","mmcif"]},
41   jvl => {shortname=>"jvl",name=>"Jalview Launch",extensions=>["jvl"],iconfile=>"Jalview-Launch"},
42   jnet => {shortname=>"jnet",name=>"JnetFile",extensions=>["concise","jnet"]},
43   scorematrix => {shortname=>"scorematrix",name=>"Substitution Matrix",extensions=>["mat"]},
44 };
45 my $add_extensions = {
46   blc => ["blc"],
47 };
48 my @put_first = qw(jalview jvl);
49
50 my $v = ($i4jversion >= 8)?$i4jversion:"";
51 my $i4jtemplatefile = "file_associations_template-install4j${v}.xml";
52 my $i4jtemplate;
53 my $mactemplatefile = "file_associations_template-Info_plist.xml";
54 my $mactemplate;
55
56 open(MT,"<$mactemplatefile") or die("Could not open '$mactemplatefile' for reading");
57 while(<MT>){
58   $mactemplate .= $_;
59 }
60 close(MT);
61 open(IT,"<$i4jtemplatefile") or die("Could not open '$i4jtemplatefile' for reading");
62 while(<IT>){
63   $i4jtemplate .= $_;
64 }
65 close(IT);
66 my $macauto;
67 my $i4jauto;
68
69 my $macautofile = $mactemplatefile;
70 $macautofile =~ s/template/auto$1/;
71
72 my $i4jautofile = $i4jtemplatefile;
73 $i4jautofile =~ s/template/auto$1/;
74
75 open(MA,">$macautofile") or die ("Could not open '$macautofile' for writing");
76 print MA "<key>CFBundleDocumentTypes</key>\n<array>\n\n";
77
78 open(IA,">$i4jautofile") or die ("Could not open '$i4jautofile' for writing");
79
80 open(IN, "<$fileformats") or die ("Could not open '$fileformats' for reading");
81 my $id = 10000;
82 my $file_associations = {};
83 while(my $line = <IN>) {
84   $line =~ s/\s+/ /g;
85   $line =~ s/(^ | $)//g;
86   if ($line =~ m/^(\w+) ?\( ?"([^"]*)" ?, ?"([^"]*)" ?, ?(true|false) ?, ?(true|false) ?\)$/i) {
87     my $shortname = lc($1);
88     next if (grep($_ eq $shortname, @dontaddshortname));
89     my $name = $2;
90     my $extensions = $3;
91     $extensions =~ s/\s+//g;
92     my @possextensions = map(lc($_),split(m/,/,$extensions));
93     my @extensions;
94     my $addext = $add_extensions->{$shortname};
95     if (ref($addext) eq "ARRAY") {
96       push(@possextensions, @$addext);
97     }
98     for my $possext (@possextensions) {
99       next if grep($_ eq $possext, @extensions);
100       next if grep($_ eq $possext, @dontaddextension);
101       push(@extensions,$possext);
102     }
103     next unless scalar(@extensions);
104     $file_associations->{$shortname} = {
105       shortname => $shortname,
106       name => $name,
107       extensions => \@extensions
108     };
109     warn("Adding file association for $shortname\n");
110   }
111 }
112 close(IN);
113
114 my %all_associations = (%$file_associations, %$add_associations);
115
116 my $num = 0;
117 my $i4jcount = 0;
118 my @ordered = @put_first;
119 for my $key (sort keys %all_associations) {
120   next if grep($_ eq $key, @ordered);
121   push(@ordered, $key);
122 }
123 for my $key (@ordered) {
124   my $a = $all_associations{$key};
125   next if (ref($a) ne "HASH");
126
127   my $extensions = $a->{extensions};
128   my @extensions = @$extensions;
129   for my $ext (@extensions) {
130     $num++;
131   }
132   #delete $all_associations{$shortname};
133   #print "NUM: $num\n";
134 }
135
136
137 for my $shortname (@ordered) {
138   my $a = $all_associations{$shortname};
139   next if (ref($a) ne "HASH");
140
141   my $name = $a->{name};
142   my $extensions = $a->{extensions};
143   my $mimetype = $mimetypes->{$shortname};
144   $mimetype = "application/x-$shortname+txt" unless $mimetype;
145   #$mimetype = "application/x-$shortname" unless $mimetype;
146
147   my $iconfile = $a->{iconfile};
148   $iconfile = "Jalview-File" unless $iconfile;
149
150   my @extensions = @$extensions;
151   #warn("LINE: $line\nFound extensions '".join("', '", @extensions)."' for $name Files ($shortname)'n");
152
153   my $xname = xml_escape($name);
154   my $xmimetype = xml_escape($mimetype);
155   my $xshortname = xml_escape($shortname);
156   my $xiconfile = xml_escape($iconfile);
157
158   my $macentry = $mactemplate;
159   $macentry =~ s/\$\$NAME\$\$/$xname/g;
160   $macentry =~ s/\$\$SHORTNAME\$\$/$xshortname/g;
161   $macentry =~ s/\$\$MIMETYPE\$\$/$xmimetype/g;
162   $macentry =~ s/\$\$ICONFILE\$\$/$xiconfile/g;
163   while ($macentry =~ m/\$\$([^\$]*)EXTENSIONS([^\$]*)\$\$/) {
164     my $pre = $1;
165     my $post = $2;
166     my $macextensions;
167     for my $ext (@extensions) {
168       my $xext = xml_escape($ext);
169       $macextensions .= $pre.$xext.$post;
170     }
171     $macentry =~ s/\$\$${pre}EXTENSIONS${post}\$\$/$macextensions/g;
172   }
173   print MA $macentry;
174
175   my $i4jentry = $i4jtemplate;
176   $i4jentry =~ s/\$\$NAME\$\$/$xname/g;
177   $i4jentry =~ s/\$\$SHORTNAME\$\$/$xshortname/g;
178   $i4jentry =~ s/\$\$MIMETYPE\$\$/$xmimetype/g;
179   $i4jentry =~ s/\$\$ICONFILE\$\$/$xiconfile/g;
180
181   my $unixext;
182   for my $ext (sort @extensions) {
183     if (not defined($unixext)) {
184       $unixext = $ext;
185       next;
186     }
187     if (length($ext) < length($unixext)) {
188       $unixext = $ext;
189       next;
190     }
191   }
192
193   for my $ext (@extensions) {
194     $i4jcount++;
195     #print "COUNT: $i4jcount\n";
196     my $progresspercent = int(($i4jcount/$num)*100);
197     #print "PC: $progresspercent\n";
198     $progresspercent = 100 if $progresspercent > 100;
199     my $xext = xml_escape($ext);
200     my $addunixextension = ($ext eq $unixext)?"true":"false";
201
202     my $i4jextentry = $i4jentry;
203     $i4jextentry =~ s/\$\$ADDUNIXEXTENSION\$\$/$addunixextension/g;
204     $i4jextentry =~ s/\$\$EXTENSION\$\$/$xext/g;
205     $i4jextentry =~ s/\$\$PROGRESSPERCENT\$\$/$progresspercent/g;
206     $i4jextentry =~ s/\$\$ID\$\$/$id/g;
207     $id++;
208     $i4jextentry =~ s/\$\$ID1\$\$/$id/g;
209     $id++;
210     $i4jextentry =~ s/\$\$ID2\$\$/$id/g;
211     $id++;
212
213     print IA $i4jextentry;
214   }
215
216   delete $all_associations{$shortname};
217 }
218
219 close(IA);
220 print MA "</array>\n";
221 close(MA);
222
223 sub xml_escape {
224   my $x = shift;
225   # stolen from Pod::Simple::XMLOutStream in base distro
226   $x =~ s/([^-\n\t !\#\$\%\(\)\*\+,\.\~\/\:\;=\?\@\[\\\]\^_\`\{\|\}abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789])/'&#'.(ord($1)).';'/eg;
227   return $x;
228 }