#!/usr/bin/env python from __future__ import absolute_import from __future__ import print_function import optparse import os import sys import subprocess from six.moves import filter from six.moves import map from six.moves import range try: import lister except ImportError as e: print("ImportError: {}".format(e)) print("You need to run the Zulip linters inside a Zulip dev environment.") print("If you are using Vagrant, you can `vagrant ssh` to enter the Vagrant guest.") sys.exit(1) class Record(object): pass def validate(fn, check_indent=True): text = open(fn).read() state = Record() def NoStartTag(end_tag): raise Exception(''' No start tag fn: %s end tag: %s line %d, col %d ''' % (fn, end_tag, state.line, state.col)) def start_tag_matcher(s, start_tag): start_line = state.line start_col = state.col state.depth += 1 old_matcher = state.matcher def f(end_tag): problem = None if start_tag != end_tag: problem = 'Mismatched tag.' elif check_indent and state.line > start_line + 1 and state.col != start_col: problem = 'Bad indentation.' if problem: raise Exception(''' fn: %s %s start: %s line %d, col %d end tag: %s line %d, col %d ''' % (fn, problem, s, start_line, start_col, end_tag, state.line, state.col)) state.matcher = old_matcher state.depth -= 1 state.matcher = f state.depth = 0 state.i = 0 state.line = 1 state.col = 1 state.matcher = NoStartTag def advance(n): for _ in range(n): state.i += 1 if state.i >= 0 and text[state.i - 1] == '\n': state.line += 1 state.col = 1 else: state.col += 1 def looking_at(s): return text[state.i:state.i+len(s)] == s while state.i < len(text): # HTML tags if looking_at("<") and not looking_at("') or tag in ['link', 'meta', '!DOCTYPE']) if not ignore: start_tag_matcher(s, tag) advance(len(s)) continue if looking_at("' or quote_count % 2 != 0): if text[end] == '"': quote_count += 1 end += 1 if text[end] != '>': raise Exception('Tag missing >') s = text[i:end+1] return s def check_our_files(): parser = optparse.OptionParser() parser.add_option('--modified', '-m', action='store_true', help='Only check modified files') (options, _) = parser.parse_args() by_lang = lister.list_files( modified_only = options.modified, ftypes=['handlebars', 'html'], group_by_ftype=True) check_handlebar_templates(by_lang['handlebars'], options.modified) check_html_templates(by_lang['html'], options.modified) def check_handlebar_templates(templates, modified_only): # Check all our handlebars templates. templates = [fn for fn in templates if fn.endswith('.handlebars')] if not modified_only: assert len(templates) >= 10 # sanity check that we are actually doing work for fn in templates: validate(fn, check_indent=True) def check_html_templates(templates, modified_only): # Our files with .html extensions are usually for Django, but we also # have some for Casper tests and a few static ones. # The file base.html has a bit of funny HTML that we can't parse here yet. templates = filter(lambda fn: 'base.html' not in fn, templates) templates = sorted(list(templates)) if not modified_only: assert len(templates) >= 10 # sanity check that we are actually doing work for fn in templates: # Many of our Django templates have broken indentation. validate(fn, check_indent=False) if __name__ == '__main__': check_our_files()