source: trunk/base/src/port1.0/portlint.tcl @ 30550

Last change on this file since 30550 was 30550, checked in by ryandesign@…, 10 years ago

be consistent about calling it an 'email address'

File size: 11.4 KB
Line 
1# et:ts=4
2# portlint.tcl
3# $Id: portlint.tcl $
4
5package provide portlint 1.0
6package require portutil 1.0
7
8set org.macports.lint [target_new org.macports.lint lint_main]
9target_runtype ${org.macports.lint} always
10target_provides ${org.macports.lint} lint
11target_requires ${org.macports.lint} main
12target_prerun ${org.macports.lint} lint_start
13
14set_ui_prefix
15
16set lint_portsystem \
17        "1.0"
18
19set lint_platforms [list \
20        "macosx" \
21        "darwin" \
22        "freebsd" \
23        "openbsd" \
24        "netbsd" \
25        "linux" \
26        "sunos" \
27        ]
28
29set lint_categories [list \
30        "aqua" \
31        "archivers" \
32        "audio" \
33        "benchmarks" \
34        "cad" \
35        "comms" \
36        "cross" \
37        "databases" \
38        "devel" \
39        "editors" \
40        "emulators" \
41        "fuse" \
42        "games" \
43        "genealogy" \
44        "gnome" \
45        "gnustep" \
46        "graphics" \
47        "iphone" \
48        "irc" \
49        "java" \
50        "kde" \
51        "lang" \
52        "mail" \
53        "math" \
54        "multimedia" \
55        "net" \
56        "news" \
57        "palm" \
58        "perl" \
59        "print" \
60        "python" \
61        "ruby" \
62        "science" \
63        "security" \
64        "shells" \
65        "sysutils" \
66        "tex" \
67        "textproc" \
68        "www" \
69        "x11" \
70        "xfce" \
71        "zope" \
72        ]
73
74set lint_required [list \
75        "name" \
76        "version" \
77        "description" \
78        "long_description" \
79        "categories" \
80        "maintainers" \
81        "platforms" \
82        "homepage" \
83        "master_sites" \
84        "checksums" \
85        ]
86
87set lint_optional [list \
88        "epoch" \
89        "revision" \
90        "worksrcdir" \
91        "distname" \
92        "use_automake" \
93        "use_autoconf" \
94        "use_configure" \
95        ]
96
97set lint_variants [list \
98        "universal" \
99        "docs" \
100        "aqua" \
101        "x11" \
102        ]
103
104
105proc seems_utf8 {str} {
106    set len [string length $str]
107    for {set i 0} {$i<$len} {incr i} {
108        set c [scan [string index $str $i] %c]
109        if {$c < 0x80} {
110            # ASCII
111            continue
112        } elseif {($c & 0xE0) == 0xC0} {
113            set n 1
114        } elseif {($c & 0xF0) == 0xE0} {
115            set n 2
116        } elseif {($c & 0xF8) == 0xF0} {
117            set n 3
118        } elseif {($c & 0xFC) == 0xF8} {
119            set n 4
120        } elseif {($c & 0xFE) == 0xFC} {
121            set n 5
122        } else {
123            return false
124        }
125        for {set j 0} {$j<$n} {incr j} {
126            incr i
127            if {$i == $len} {
128                return false
129            } elseif {([scan [string index $str $i] %c] & 0xC0) != 0x80} {
130                return false
131            }
132        }
133    }
134    return true
135}
136
137
138proc lint_start {args} {
139    global UI_PREFIX portname
140    ui_msg "$UI_PREFIX [format [msgcat::mc "Verifying Portfile for %s"] ${portname}]"
141}
142
143proc lint_main {args} {
144        global UI_PREFIX portname portpath portresourcepath
145        set portfile ${portpath}/Portfile
146        set groupdir ${portresourcepath}/group
147
148        set warnings 0
149        set errors 0
150
151    ###################################################################
152    ui_debug "$portfile"
153
154    set topline_number 1
155    set require_blank false
156    set require_after ""
157    set seen_portsystem false
158    set seen_portgroup false
159    set in_description false
160
161    set local_variants [list]
162
163    set f [open $portfile RDONLY]
164    # read binary (to check UTF-8)
165    fconfigure $f -encoding binary
166    set lineno 1
167    while {1} {
168        set line [gets $f]
169        if {[eof $f]} {
170            seek $f -1 end
171            set last [read $f 1]
172            if {![string match "\n" $last]} {
173                ui_warn "Line $lineno has missing newline (at end of file)"
174                incr warnings
175            }
176            close $f
177            break
178        }
179        ui_debug "$lineno: $line"
180
181        if {![seems_utf8 $line]} {
182            ui_error "Line $lineno seems to contain an invalid UTF-8 sequence"
183            incr errors
184        }
185
186        if {[string equal "PortSystem" $require_after] && \
187            [string match "PortGroup*" $line]} {
188            set require_blank false
189        }
190
191        if {$require_blank && ($line != "")} {
192            ui_warn "Line $lineno should be a newline (after $require_after)"
193            incr warnings
194        }
195        set require_blank false
196
197        if {[string match "* " $line] || [string match "*\t" $line] &&
198            [string trim $line] != "" } {
199            # allow indented blank lines between blocks of code and such
200            ui_warn "Line $lineno has trailing whitespace before newline"
201            incr warnings
202        }
203
204        if {($lineno == $topline_number) && [string match "*-\*- Mode:*" $line]} {
205            ui_info "OK: Line $lineno has emacs/vim Mode"
206            incr topline_number
207        }
208        if {($lineno == $topline_number) && ![string match "*\$Id*" $line]} {
209            ui_warn "Line $lineno is missing RCS tag (\$Id)"
210            incr warnings
211        } elseif {($lineno == $topline_number)} {
212            ui_info "OK: Line $lineno has RCS tag (\$Id)"
213            set require_blank true
214            set require_after "RCS tag"
215        }
216
217        if {[string match "PortSystem*" $line]} {
218            if {$seen_portsystem} {
219                 ui_error "Line $lineno repeats PortSystem information"
220                 incr errors
221            }
222            regexp {PortSystem\s+([0-9.]+)} $line -> portsystem
223            if {![info exists portsystem]} {
224                 ui_error "Line $lineno has unrecognized PortSystem"
225                 incr errors
226            }
227            set seen_portsystem true
228            set require_blank true
229            set require_after "PortSystem"
230        }
231        if {[string match "PortGroup*" $line]} {
232            if {$seen_portgroup} {
233                 ui_error "Line $lineno repeats PortGroup information"
234                 incr errors
235            }
236            regexp {PortGroup\s+([a-z0-9]+)\s+([0-9.]+)} $line -> portgroup portgroupversion
237            if {![info exists portgroup]} {
238                 ui_error "Line $lineno has unrecognized PortGroup"
239                 incr errors
240            }
241            set seen_portgroup true
242            set require_blank true
243            set require_after "PortGroup"
244        }
245
246        # TODO: check for repeated variable definitions
247        # TODO: check the definition order of variables
248        # TODO: check length of description against max
249
250        if {[string match "long_description*" $line]} {
251            set in_description true
252        }
253        if {$in_description && ([string range $line end end] != "\\")} {
254            set in_description false
255            #set require_blank true
256            #set require_after "long_description"
257        } elseif {$in_description} {
258            set require_blank false
259        }
260
261        if {[string match "variant*" $line]} {
262            regexp {variant\s+(\w+)} $line -> variantname
263            if {[info exists variantname]} {
264                 lappend local_variants $variantname
265            }
266        }
267
268        ### TODO: more checks to Portfile syntax
269
270        incr lineno
271    }
272
273    ###################################################################
274
275    global os.platform os.arch os.version
276    global portversion portrevision portepoch
277    # hoping for "noarch" :
278    set portarch ${os.arch}
279    global description long_description platforms categories all_variants
280    global maintainers homepage master_sites checksums patchfiles
281   
282    global lint_portsystem lint_platforms lint_categories
283    global lint_required lint_optional lint_variants
284
285    if (!$seen_portsystem) {
286        ui_error "Didn't find PortSystem specification"
287        incr errors
288    }  elseif {$portsystem != $lint_portsystem} {
289        ui_error "Unknown PortSystem: $portsystem"
290        incr errors
291    } else {
292        ui_info "OK: Found PortSystem $portsystem"
293    }
294    if (!$seen_portgroup) {
295        # PortGroup is optional, so missing is OK
296    }  elseif {![file exists $groupdir/$portgroup-$portgroupversion.tcl]} {
297        ui_error "Unknown PortGroup: $portgroup-$portgroupversion"
298        incr errors
299    } else {
300        ui_info "OK: Found PortGroup $portgroup-$portgroupversion"
301    }
302
303    foreach req_var $lint_required {
304        if {$req_var == "name"} {
305            set var "portname"
306        } elseif {$req_var == "version"} {
307            set var "portversion"
308        } else {
309            set var $req_var
310        }
311       if {![info exists $var]} {
312            ui_error "Missing required variable: $req_var"
313            incr errors
314        } else {
315            ui_info "OK: Found required variable: $req_var"
316        }
317    }
318
319    foreach opt_var $lint_optional {
320       if {$opt_var == "epoch"} {
321            set var "portepoch"
322        } elseif {$opt_var == "revision"} {
323            set var "portrevision"
324        } else {
325            set var $opt_var
326       }
327       if {[info exists $var]} {
328            # TODO: check whether it was seen (or default)
329            ui_info "OK: Found optional variable: $opt_var"
330       }
331    }
332
333    if {[info exists platforms]} {
334        foreach platform $platforms {
335           if {[lsearch -exact $lint_platforms $platform] == -1} {
336                ui_error "Unknown platform: $platform"
337                incr errors
338            } else {
339                ui_info "OK: Found platform: $platform"
340            }
341        }
342    }
343
344    if {[info exists categories]} {
345        foreach category $categories {
346           if {[lsearch -exact $lint_categories $category] == -1} {
347                ui_error "Unknown category: $category"
348                incr errors
349            } else {
350                ui_info "OK: Found category: $category"
351            }
352        }
353    }
354
355    if {![string is integer -strict $portepoch]} {
356        ui_error "Port epoch is not numeric:  $portepoch"
357        incr errors
358    }
359    if {![string is integer -strict $portrevision]} {
360        ui_error "Port revision is not numeric: $portrevision"
361        incr errors
362    }
363
364    set variantnumber 1
365    foreach variant $all_variants {
366        set variantname [ditem_key $variant name] 
367        set variantdesc [lindex [ditem_key $variant description] 0]
368        if {![info exists variantname] || $variantname == ""} {
369            ui_error "Variant number $variantnumber does not have a name"
370            incr errors
371        } elseif {![info exists variantdesc] || $variantdesc == ""} {
372            ui_info "OK: Found variant: $variantname"
373            # don't warn about missing descriptions for global variants
374            if {[lsearch -exact $local_variants $variantname] != -1 &&
375                [lsearch -exact $lint_variants $variantname] == -1} {
376                ui_warn "Variant $variantname does not have a description"
377                incr warnings
378            }
379        } else {
380            ui_info "OK: Found variant $variantname: $variantdesc"
381        }
382        incr variantnumber
383    }
384
385    if {[string match "*darwinports@opendarwin.org*" $maintainers]} {
386        ui_warn "Using legacy email address for no/open maintainer"
387        incr warnings
388    }
389
390    if {[string match "*nomaintainer@macports.org*" $maintainers] ||
391        [string match "*openmaintainer@macports.org*" $maintainers]} {
392        ui_warn "Using full email address for no/open maintainer"
393        incr warnings
394    }
395
396    if {[info exists patchfiles]} {
397        foreach patchfile $patchfiles {
398            if {![string match "patch-*.diff" $patchfile]} {
399                ui_warn "Patchfile $patchfile does not follow the source patch naming policy \"patch-*.diff\""
400                incr warnings
401            }
402        }
403    }
404
405    ### TODO: more checks to Tcl variables/sections
406
407    ui_debug "Name: $portname"
408    ui_debug "Epoch: $portepoch"
409    ui_debug "Version: $portversion"
410    ui_debug "Revision: $portrevision"
411    ui_debug "Arch: $portarch"
412    ###################################################################
413
414        ui_msg "$UI_PREFIX [format [msgcat::mc "%d errors and %d warnings found."] $errors $warnings]"
415
416        return {$errors > 0}
417}
Note: See TracBrowser for help on using the repository browser.