source: wikiextrasplugin/tags/1.3.1/tracwikiextras/unc_paths.py

# -*- coding: iso-8859-1 -*-
#
# Copyright (C) 2006-2011 Christian Boos <cboos@neuf.fr>
# All rights reserved.
#
# This software is licensed as described in the file COPYING, which
# you should have received as part of this distribution. The terms
# are also available at http://trac.edgewall.com/license.html.
#
# Author: Christian Boos <cboos@neuf.fr>

from trac.util.html import Markup, html as tag

from trac.core import implements, Component
from trac.wiki import IWikiSyntaxProvider


class UNCPathLink(Component):
    """Transform UNC paths to `file://` links.

    The UNC (Universal Naming Convention) specifies a common syntax to describe
    the location of a network resource, such as a shared file, directory, or
    printer. The UNC syntax has the generic form:
    {{{
    \\\\ComputerName\SharedFolder\Resource
    }}}

    Activate this component to automatically transform UNC paths to `file://`
    links. The following wiki markups are supported:
    {{{
    \\\\ComputerName\SharedFolder\Resource
    [\\\\ComputerName\SharedFolder\Resource Label]
    [unc:\\\\ComputerName\SharedFolder\Resource Label]
    [unc:"\\\\ComputerName\SharedFolder\Resource" Label]
    }}}

    Some web browsers need a plugin to enable them to open `file://` links on
    web pages with `http(s)://`-URLs:
     * Chrome:
       [https://chrome.google.com/webstore/detail/jllpkdkcdjndhggodimiphkghogcpida LocalLinks]
       plugin
     * Firefox: [http://locallink.mozdev.org/ LocalLink] plugin
     * IE9: supported by default
    """

    implements(IWikiSyntaxProvider)

    # IWikiSyntaxProvider methods

    _unc_path_regexp = (
        r'!?(?:\\\\[^\s\\\\/]+(?:[\\/][^\s\\]*)+' # \\host\share[\path]
        r'|"\\\\[^"\s\\\\/]+(?:[\\/][^"\\]*)+"' # "\\host\share[\path ...]"
        r'|<\\\\[^>\s\\\\/]+(?:[\\/][^>\\]*)+>' # <\\host\share[\path ...]>
        r'|\[(?P<unc_path>\\\\[^\s\\\\/]+(?:[\\/][^\s\\]*)+)'
        r'(?P<unc_label>\s+[^]]+)?\]' # [\\host\share\path label]
        r')')

    def get_wiki_syntax(self):
        def filelink(formatter, match, fullmatch):
            label = None
            if match[0] == '[':
                match, label = (fullmatch.group('unc_path'),
                                fullmatch.group('unc_label'))
            elif match[0] in '"<':
                match = match[1:-1]
            return tag.a(label or match,
                         href='file:///%s' % match.replace('\\', '/'))
        yield (self._unc_path_regexp, filelink)

    def get_link_resolvers(self):
        def filelink(formatter, ns, target, label, fullmatch=None):
            return tag.a(label or target,
                         href='file:///%s' % target.replace('\\', '/'))
        yield ('unc', filelink)