DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Mercurial (85b4e005b39c)

VCS Links

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, # You can obtain one at http://mozilla.org/MPL/2.0/.

from __future__ import absolute_import, print_function, unicode_literals

import sys

from mach.decorators import (
    CommandArgument,
    CommandProvider,
    Command,
    SubCommand,
)

from mozbuild.base import MachCommandBase, MozbuildObject


@CommandProvider
class BustedProvider(object):
    @Command('busted', category='misc',
             description='Query known bugs in our tooling, and file new ones.')
    def busted_default(self):
        import requests
        payload = {'include_fields': 'id,summary,last_change_time',
                   'blocks': 1543241,
                   'resolution': '---'}
        response = requests.get('https://bugzilla.mozilla.org/rest/bug', payload)
        response.raise_for_status()
        json_response = response.json()
        if 'bugs' in json_response and len(json_response['bugs']) > 0:
            # Display most recently modifed bugs first.
            bugs = sorted(json_response['bugs'], key=lambda item: item['last_change_time'],
                          reverse=True)
            for bug in bugs:
                print("Bug %s - %s" % (bug['id'], bug['summary']))
        else:
            print("No known tooling issues found.")

    @SubCommand('busted',
                'file',
                description='File a bug for busted tooling.')
    def busted_file(self):
        import webbrowser
        uri = ('https://bugzilla.mozilla.org/enter_bug.cgi?'
               'product=Firefox%20Build%20System&component=General&blocked=1543241')
        webbrowser.open_new_tab(uri)


@CommandProvider
class SearchProvider(object):
    @Command('searchfox', category='misc',
             description='Search for something in Searchfox.')
    @CommandArgument('term', nargs='+', help='Term(s) to search for.')
    def searchfox(self, term):
        import webbrowser
        term = ' '.join(term)
        uri = 'https://searchfox.org/mozilla-central/search?q=%s' % term
        webbrowser.open_new_tab(uri)
    @Command('dxr', category='misc',
             description='Search for something in DXR.')
    @CommandArgument('term', nargs='+', help='Term(s) to search for.')
    def dxr(self, term):
        import webbrowser
        term = ' '.join(term)
        uri = 'http://dxr.mozilla.org/mozilla-central/search?q=%s&redirect=true' % term
        webbrowser.open_new_tab(uri)

    @Command('mdn', category='misc',
             description='Search for something on MDN.')
    @CommandArgument('term', nargs='+', help='Term(s) to search for.')
    def mdn(self, term):
        import webbrowser
        term = ' '.join(term)
        uri = 'https://developer.mozilla.org/search?q=%s' % term
        webbrowser.open_new_tab(uri)

    @Command('google', category='misc',
             description='Search for something on Google.')
    @CommandArgument('term', nargs='+', help='Term(s) to search for.')
    def google(self, term):
        import webbrowser
        term = ' '.join(term)
        uri = 'https://www.google.com/search?q=%s' % term
        webbrowser.open_new_tab(uri)

    @Command('search', category='misc',
             description='Search for something on the Internets. '
             'This will open 4 new browser tabs and search for the term on Google, '
             'MDN, DXR, and Searchfox.')
    @CommandArgument('term', nargs='+', help='Term(s) to search for.')
    def search(self, term):
        self.google(term)
        self.mdn(term)
        self.dxr(term)
        self.searchfox(term)


@CommandProvider
class UUIDProvider(object):
    @Command('uuid', category='misc',
             description='Generate a uuid.')
    @CommandArgument('--format', '-f', choices=['idl', 'cpp', 'c++'],
                     help='Output format for the generated uuid.')
    def uuid(self, format=None):
        import uuid
        u = uuid.uuid4()
        if format in [None, 'idl']:
            print(u)
            if format is None:
                print('')
        if format in [None, 'cpp', 'c++']:
            u = u.hex
            print('{ 0x%s, 0x%s, 0x%s, \\' % (u[0:8], u[8:12], u[12:16]))
            pairs = tuple(map(lambda n: u[n:n+2], range(16, 32, 2)))
            print(('  { ' + '0x%s, ' * 7 + '0x%s } }') % pairs)


MACH_PASTEBIN_DURATIONS = {
    'onetime': 'onetime',
    'hour': '3600',
    'day': '86400',
    'week': '604800',
    'month': '2073600',
}

EXTENSION_TO_HIGHLIGHTER = {
    '.hgrc': 'ini',
    'Dockerfile': 'docker',
    'Makefile': 'make',
    'applescript': 'applescript',
    'arduino': 'arduino',
    'bash': 'bash',
    'bat': 'bat',
    'c': 'c',
    'clojure': 'clojure',
    'cmake': 'cmake',
    'coffee': 'coffee-script',
    'console': 'console',
    'cpp': 'cpp',
    'cs': 'csharp',
    'css': 'css',
    'cu': 'cuda',
    'cuda': 'cuda',
    'dart': 'dart',
    'delphi': 'delphi',
    'diff': 'diff',
    'django': 'django',
    'docker': 'docker',
    'elixir': 'elixir',
    'erlang': 'erlang',
    'go': 'go',
    'h': 'c',
    'handlebars': 'handlebars',
    'haskell': 'haskell',
    'hs': 'haskell',
    'html': 'html',
    'ini': 'ini',
    'ipy': 'ipythonconsole',
    'ipynb': 'ipythonconsole',
    'irc': 'irc',
    'j2': 'django',
    'java': 'java',
    'js': 'js',
    'json': 'json',
    'jsx': 'jsx',
    'kt': 'kotlin',
    'less': 'less',
    'lisp': 'common-lisp',
    'lsp': 'common-lisp',
    'lua': 'lua',
    'm': 'objective-c',
    'make': 'make',
    'matlab': 'matlab',
    'md': '_markdown',
    'nginx': 'nginx',
    'numpy': 'numpy',
    'patch': 'diff',
    'perl': 'perl',
    'php': 'php',
    'pm': 'perl',
    'postgresql': 'postgresql',
    'py': 'python',
    'rb': 'rb',
    'rs': 'rust',
    'rst': 'rst',
    'sass': 'sass',
    'scss': 'scss',
    'sh': 'bash',
    'sol': 'sol',
    'sql': 'sql',
    'swift': 'swift',
    'tex': 'tex',
    'typoscript': 'typoscript',
    'vim': 'vim',
    'xml': 'xml',
    'xslt': 'xslt',
    'yaml': 'yaml',
    'yml': 'yaml'
}


def guess_highlighter_from_path(path):
    '''Return a known highlighter from a given path

    Attempt to select a highlighter by checking the file extension in the mapping
    of extensions to highlighter. If that fails, attempt to pass the basename of
    the file. Return `_code` as the default highlighter if that fails.
    '''
    import os

    _name, ext = os.path.splitext(path)

    if ext.startswith('.'):
        ext = ext[1:]

    if ext in EXTENSION_TO_HIGHLIGHTER:
        return EXTENSION_TO_HIGHLIGHTER[ext]

    basename = os.path.basename(path)

    return EXTENSION_TO_HIGHLIGHTER.get(basename, '_code')


PASTEMO_MAX_CONTENT_LENGTH = 250 * 1024 * 1024

PASTEMO_URL = 'https://paste.mozilla.org/api/'

MACH_PASTEBIN_DESCRIPTION = '''
Command line interface to paste.mozilla.org.

Takes either a filename whose content should be pasted, or reads
content from standard input. If a highlighter is specified it will
be used, otherwise the file name will be used to determine an
appropriate highlighter.
'''


@CommandProvider
class PastebinProvider(object):
    @Command('pastebin', category='misc',
             description=MACH_PASTEBIN_DESCRIPTION)
    @CommandArgument('--list-highlighters', action='store_true',
                     help='List known highlighters and exit')
    @CommandArgument('--highlighter', default=None,
                     help='Syntax highlighting to use for paste')
    @CommandArgument('--expires', default='week',
                     choices=sorted(MACH_PASTEBIN_DURATIONS.keys()),
                     help='Expire paste after given time duration (default: %(default)s)')
    @CommandArgument('--verbose', action='store_true',
                     help='Print extra info such as selected syntax highlighter')
    @CommandArgument('path', nargs='?', default=None,
                     help='Path to file for upload to paste.mozilla.org')
    def pastebin(self, list_highlighters, highlighter, expires, verbose, path):
        import requests

        def verbose_print(*args, **kwargs):
            '''Print a string if `--verbose` flag is set'''
            if verbose:
                print(*args, **kwargs)

        # Show known highlighters and exit.
        if list_highlighters:
            lexers = set(EXTENSION_TO_HIGHLIGHTER.values())
            print('Available lexers:\n'
                  '    - %s' % '\n    - '.join(sorted(lexers)))
            return 0

        # Get a correct expiry value.
        try:
            verbose_print('Setting expiry from %s' % expires)
            expires = MACH_PASTEBIN_DURATIONS[expires]
            verbose_print('Using %s as expiry' % expires)
        except KeyError:
            print('%s is not a valid duration.\n'
                  '(hint: try one of %s)' %
                  (expires, ', '.join(MACH_PASTEBIN_DURATIONS.keys())))
            return 1

        data = {
            'format': 'json',
            'expires': expires,
        }

        # Get content to be pasted.
        if path:
            verbose_print('Reading content from %s' % path)
            try:
                with open(path, 'r') as f:
                    content = f.read()
            except IOError:
                print('ERROR. No such file %s' % path)
                return 1

            lexer = guess_highlighter_from_path(path)
            if lexer:
                data['lexer'] = lexer
        else:
            verbose_print('Reading content from stdin')
            content = sys.stdin.read()

        # Assert the length of content to be posted does not exceed the maximum.
        content_length = len(content)
        verbose_print('Checking size of content is okay (%d)' % content_length)
        if content_length > PASTEMO_MAX_CONTENT_LENGTH:
            print('Paste content is too large (%d, maximum %d)' %
                  (content_length, PASTEMO_MAX_CONTENT_LENGTH))
            return 1

        data['content'] = content

        # Highlight as specified language, overwriting value set from filename.
        if highlighter:
            verbose_print('Setting %s as highlighter' % highlighter)
            data['lexer'] = highlighter

        try:
            verbose_print('Sending request to %s' % PASTEMO_URL)
            resp = requests.post(PASTEMO_URL, data=data)

            # Error code should always be 400.
            # Response content will include a helpful error message,
            # so print it here (for example, if an invalid highlighter is
            # provided, it will return a list of valid highlighters).
            if resp.status_code >= 400:
                print('Error code %d: %s' % (resp.status_code, resp.content))
                return 1

            verbose_print('Pasted successfully')

            response_json = resp.json()

            verbose_print('Paste highlighted as %s' % response_json['lexer'])
            print(response_json['url'])

            return 0
        except Exception as e:
            print('ERROR. Paste failed.')
            print('%s' % e)
        return 1


def mozregression_import():
    # Lazy loading of mozregression.
    # Note that only the mach_interface module should be used from this file.
    try:
        import mozregression.mach_interface
    except ImportError:
        return None
    return mozregression.mach_interface


def mozregression_create_parser():
    # Create the mozregression command line parser.
    # if mozregression is not installed, or not up to date, it will
    # first be installed.
    cmd = MozbuildObject.from_environment()
    cmd._activate_virtualenv()
    mozregression = mozregression_import()
    if not mozregression:
        # mozregression is not here at all, install it
        cmd.virtualenv_manager.install_pip_package('mozregression')
        print("mozregression was installed. please re-run your"
              " command. If you keep getting this message please "
              " manually run: 'pip install -U mozregression'.")
    else:
        # check if there is a new release available
        release = mozregression.new_release_on_pypi()
        if release:
            print(release)
            # there is one, so install it. Note that install_pip_package
            # does not work here, so just run pip directly.
            cmd.virtualenv_manager._run_pip([
                'install',
                'mozregression==%s' % release
            ])
            print("mozregression was updated to version %s. please"
                  " re-run your command." % release)
        else:
            # mozregression is up to date, return the parser.
            return mozregression.parser()
    # exit if we updated or installed mozregression because
    # we may have already imported mozregression and running it
    # as this may cause issues.
    sys.exit(0)


@CommandProvider
class MozregressionCommand(MachCommandBase):
    @Command('mozregression',
             category='misc',
             description=("Regression range finder for nightly"
                          " and inbound builds."),
             parser=mozregression_create_parser)
    def run(self, **options):
        self._activate_virtualenv()
        mozregression = mozregression_import()
        mozregression.run(options)