(0.9.2compat) expand keywords in raw web output, and other changes from default branch
Comment out import related tests, as not always available.
# keyword.py - $Keyword$ expansion for Mercurial## Copyright 2007, 2008 Christian Ebert <blacktrash@gmx.net>## This software may be used and distributed according to the terms# of the GNU General Public License, incorporated herein by reference.## $Id$## Keyword expansion hack against the grain of a DSCM## There are many good reasons why this is not needed in a distributed# SCM, still it may be useful in very small projects based on single# files (like LaTeX packages), that are mostly addressed to an audience# not running a version control system.## For in-depth discussion refer to# <http://www.selenic.com/mercurial/wiki/index.cgi/KeywordPlan>.## Keyword expansion is based on Mercurial's changeset template mappings.## Binary files are not touched.## Setup in hgrc:## [extensions]# # enable extension# keyword = /full/path/to/hgkw/keyword.py# # or, if script in canonical hgext folder:# # hgext.keyword =## Files to act upon/ignore are specified in the [keyword] section.# Customized keyword template mappings in the [keywordmaps] section.## Run "hg help keyword" and "hg kwdemo" to get info on configuration.'''keyword expansion in local repositoriesThis extension expands RCS/CVS-like or self-customized $Keywords$in tracked text files selected by your configuration.Keywords are only expanded in local repositories and not stored inthe change history. The mechanism can be regarded as a conveniencefor the current user or for archive distribution.Configuration is done in the [keyword] and [keywordmaps] sectionsof hgrc files.Example: [keyword] # expand keywords in every python file except those matching "x*" **.py = x* = ignoreNote: the more specific you are in your filename patterns the less you lose speed in huge repos.For [keywordmaps] template mapping and expansion demonstration andcontrol run "hg kwdemo".An additional date template filter {date|utcdate} is provided.The default template mappings (view with "hg kwdemo -d") can be replacedwith customized keywords and templates.Again, run "hg kwdemo" to control the results of your config changes.Before changing/disabling active keywords, run "hg kwshrink" to avoidthe risk of inadvertedly storing expanded keywords in the change history.To force expansion after enabling it, or a configuration change, run"hg kwexpand".Also, when committing with the record extension or using mq's qrecord, be awarethat keywords cannot be updated. Again, run "hg kwexpand" on the files inquestion to update keyword expansions after all changes have been checked in.Expansions spanning more than one line and incremental expansions,like CVS' $Log$, are not supported. A keyword template map"Log = {desc}" expands to the first line of the changeset description.Caveat: With Mercurial versions prior to 4574925db5c0 "hg import" might cause rejects if the patch context contains an active keyword. In that case run "hg kwshrink", and then reimport. Or, better, use bundle/unbundle to share changes.'''frommercurialimportcommands,cmdutil,contextfrommercurialimportlocalrepo,revlog,templater,utilfrommercurial.nodeimport*frommercurial.i18nimportgettextas_importmimetypes,os.path,re,shutil,tempfile,timetry:# avoid spurious rejects if patchfile is availablefrommercurial.patchimportpatchfile_patchfile_init=patchfile.__init__exceptImportError:_patchfile_init=None# backwards compatibility hackstry:# templatefilters module introduced in 9f1e6ab76069frommercurialimporttemplatefilterstemplate_filters=templatefilters.filterstemplate_firstline=templatefilters.firstlineexceptImportError:template_filters=templater.common_filterstemplate_firstline=templater.firstlinetry:# webcommands module introduced in 08887121a652frommercurial.hgwebimportwebcommands_webcommands=Truekwweb_func=webcommands.rawfileexceptImportError:frommercurial.hgwebimporthgweb_mod_webcommands=Falsedef_normal(repo,files):'''Backwards compatible repo.dirstate.normal/update.'''# 6fd953d5faea introduced dirstate.normal()try:forfinfiles:repo.dirstate.normal(f)exceptAttributeError:repo.dirstate.update(files,'n')def_pathto(repo,f,cwd=None):'''kwfiles behaves similar to status, using pathto since 78b6add1f966.'''try:returnrepo.pathto(f,cwd)exceptAttributeError:returnfcommands.optionalrepo+=' kwdemo'defutcdate(date):'''Returns hgdate in cvs-like UTC format.'''returntime.strftime('%Y/%m/%d %H:%M:%S',time.gmtime(date[0]))classkwtemplater(object):''' Sets up keyword templates, corresponding keyword regex, and provides keyword substitution functions. '''templates={'Revision':'{node|short}','Author':'{author|user}','Date':'{date|utcdate}','RCSFile':'{file|basename},v','Source':'{root}/{file},v','Id':'{file|basename},v {node|short} {date|utcdate} {author|user}','Header':'{root}/{file},v {node|short} {date|utcdate} {author|user}',}def__init__(self,ui,repo,inc,exc):self.ui=uiself.repo=repoself.matcher=util.matcher(repo.root,inc=inc,exc=exc)[1]self.ctx=Nonekwmaps=self.ui.configitems('keywordmaps')ifkwmaps:# override default templateskwmaps=[(k,templater.parsestring(v,quoted=False))for(k,v)inkwmaps]self.templates=dict(kwmaps)escaped=map(re.escape,self.templates.keys())kwpat=r'\$(%s)(: [^$\n\r]*? )??\$'%'|'.join(escaped)self.re_kw=re.compile(kwpat)template_filters['utcdate']=utcdateself.ct=self._changeset_templater()def_changeset_templater(self):'''Backwards compatible cmdutil.changeset_templater.'''# before 1e0b94cfba0e there was an extra "brinfo" argumenttry:returncmdutil.changeset_templater(self.ui,self.repo,False,'',False)exceptTypeError:returncmdutil.changeset_templater(self.ui,self.repo,False,None,'',False)defsubstitute(self,path,data,node,subfunc):'''Obtains file's changenode if node not given, and calls given substitution function.'''ifnodeisNone:# kwrepo.wwrite except when overwriting on commitifself.ctxisNone:self.ctx=self.repo.changectx()try:fnode=self.ctx.filenode(path)fl=self.repo.file(path)c=context.filectx(self.repo,path,fileid=fnode,filelog=fl)node=c.node()exceptrevlog.LookupError:# eg: convertreturnsubfunc==self.re_kw.subanddataor(data,None)defkwsub(mobj):'''Substitutes keyword using corresponding template.'''kw=mobj.group(1)self.ct.use_template(self.templates[kw])self.ui.pushbuffer()self.ct.show(changenode=node,root=self.repo.root,file=path)ekw=template_firstline(self.ui.popbuffer())return'$%s: %s $'%(kw,ekw)returnsubfunc(kwsub,data)defexpand(self,path,data,node):'''Returns data with keywords expanded.'''ifutil.binary(data):returndatareturnself.substitute(path,data,node,self.re_kw.sub)defprocess(self,path,data,expand,ctx,node):'''Returns a tuple: data, count. Count is number of keywords/keyword substitutions, telling caller whether to act on file containing data.'''ifutil.binary(data):returndata,Noneifexpand:self.ctx=ctxreturnself.substitute(path,data,node,self.re_kw.subn)returnself.re_kw.subn(r'$\1$',data)defshrink(self,data):'''Returns text with all keyword substitutions removed.'''ifutil.binary(data):returndatareturnself.re_kw.sub(r'$\1$',data)def_status(ui,repo,*pats,**opts):'''Bails out if [keyword] configuration is not active. Returns status of working directory.'''ifhasattr(repo,'_kwt'):files,match,anypats=cmdutil.matchpats(repo,pats,opts)returnrepo.status(files=files,match=match,list_clean=True)ifui.configitems('keyword'):raiseutil.Abort(_('[keyword] patterns cannot match'))raiseutil.Abort(_('no [keyword] patterns configured'))def_overwrite(ui,repo,node=None,expand=True,files=None):'''Overwrites selected files expanding/shrinking keywords.'''ctx=repo.changectx(node)mf=ctx.manifest()ifnodeisnotNone:# commitfiles=[fforfinctx.files()iffinmf]notify=ui.debugelse:# kwexpand/kwshrinknotify=ui.notecandidates=[fforfinfilesifnotmf.linkf(f)andrepo._kwt.matcher(f)]ifcandidates:overwritten=[]candidates.sort()action=expandand'expanding'or'shrinking'forfincandidates:data,kwfound=repo._wreadkwct(f,expand,ctx,node)ifkwfound:notify(_('overwriting %s%s keywords\n')%(f,action))repo.wwrite(f,data,mf.flags(f),overwrite=True)overwritten.append(f)_normal(repo,overwritten)def_kwfwrite(ui,repo,expand,*pats,**opts):'''Selects files and passes them to _overwrite.'''status=_status(ui,repo,*pats,**opts)modified,added,removed,deleted,unknown,ignored,clean=statusifmodifiedoraddedorremovedordeleted:raiseutil.Abort(_('outstanding uncommitted changes in given files'))wlock=lock=Nonetry:wlock=repo.wlock()lock=repo.lock()_overwrite(ui,repo,expand=expand,files=clean)finally:delwlock,lockdefcat(ui,repo,file1,*pats,**opts):'''output the current or given revision of files expanding keywords Print the specified files as they were at the given revision. If no revision is given, the parent of the working directory is used, or tip if no revision is checked out. Output may be to a file, in which case the name of the file is given using a format string. The formatting rules are the same as for the export command, with the following additions: %s basename of file being printed %d dirname of file being printed, or '.' if in repo root %p root-relative path name of file being printed '''ctx=repo.changectx(opts['rev'])try:repo._kwt.ctx=ctxkw=TrueexceptAttributeError:kw=Falseerr=1forsrc,abs,rel,exactincmdutil.walk(repo,(file1,)+pats,opts,ctx.node()):fp=cmdutil.make_file(repo,opts['output'],ctx.node(),pathname=abs)data=ctx.filectx(abs).data()ifkwandrepo._kwt.matcher(abs):data=repo._kwt.expand(abs,data,None)fp.write(data)err=0returnerrdefdemo(ui,repo,*args,**opts):'''print [keywordmaps] configuration and an expansion example Show current, custom, or default keyword template maps and their expansion. Extend current configuration by specifying maps as arguments and optionally by reading from an additional hgrc file. Override current keyword template maps with "default" option. '''defdemostatus(stat):ui.status(_('\n\t%s\n')%stat)defdemoitems(section,items):ui.write('[%s]\n'%section)fork,vinitems:ui.write('%s = %s\n'%(k,v))msg='hg keyword config and expansion example'kwstatus='current'fn='demo.txt'branchname='demobranch'tmpdir=tempfile.mkdtemp('','kwdemo.')ui.note(_('creating temporary repo at %s\n')%tmpdir)repo=localrepo.localrepository(ui,path=tmpdir,create=True)ui.setconfig('keyword',fn,'')ifargsoropts.get('rcfile'):kwstatus='custom'ifopts.get('rcfile'):ui.readconfig(opts.get('rcfile'))ifopts.get('default'):kwstatus='default'kwmaps=kwtemplater.templatesifui.configitems('keywordmaps'):# override maps from optional rcfilefork,vinkwmaps.iteritems():ui.setconfig('keywordmaps',k,v)elifargs:# simulate hgrc parsingrcmaps=['[keywordmaps]\n']+[a+'\n'forainargs]fp=repo.opener('hgrc','w')fp.writelines(rcmaps)fp.close()ui.readconfig(repo.join('hgrc'))ifnotopts.get('default'):kwmaps=dict(ui.configitems('keywordmaps'))orkwtemplater.templatesreposetup(ui,repo)fork,vinui.configitems('extensions'):ifk.endswith('keyword'):extension='%s = %s'%(k,v)breakdemostatus('config using %s keyword template maps'%kwstatus)ui.write('[extensions]\n%s\n'%extension)demoitems('keyword',ui.configitems('keyword'))demoitems('keywordmaps',kwmaps.iteritems())keywords='$'+'$\n$'.join(kwmaps.keys())+'$\n'repo.wopener(fn,'w').write(keywords)repo.add([fn])path=repo.wjoin(fn)ui.note(_('\n%s keywords written to %s:\n')%(kwstatus,path))ui.note(keywords)ui.note('\nhg -R "%s" branch "%s"\n'%(tmpdir,branchname))# silence branch command if not verbosequiet=ui.quietui.quiet=notui.verbosecommands.branch(ui,repo,branchname)ui.quiet=quietforname,cmdinui.configitems('hooks'):ifname.split('.',1)[0].find('commit')>-1:repo.ui.setconfig('hooks',name,'')ui.note(_('unhooked all commit hooks\n'))ui.note('hg -R "%s" ci -m "%s"\n'%(tmpdir,msg))repo.commit(text=msg)format=ui.verboseand' in %s'%pathor''demostatus('%s keywords expanded%s'%(kwstatus,format))ui.write(repo.wopener(fn).read())ui.debug(_('\nremoving temporary repo %s\n')%tmpdir)shutil.rmtree(tmpdir,ignore_errors=True)defexpand(ui,repo,*pats,**opts):'''expand keywords in working directory Run after (re)enabling keyword expansion. kwexpand refuses to run if given files contain local changes. '''# 3rd argument sets expansion to True_kwfwrite(ui,repo,True,*pats,**opts)deffiles(ui,repo,*pats,**opts):'''print files currently configured for keyword expansion Crosscheck which files in working directory are potential targets for keyword expansion. That is, files matched by [keyword] config patterns but not symlinks. '''status=_status(ui,repo,*pats,**opts)modified,added,removed,deleted,unknown,ignored,clean=statusfiles=modified+added+cleanifopts.get('untracked'):files+=unknownfiles.sort()# use full def of repo._link for backwards compatibilitykwfiles=[fforfinfilesifnotos.path.islink(repo.wjoin(f))andrepo._kwt.matcher(f)]cwd=patsandrepo.getcwd()or''kwfstats=notopts.get('ignore')and(('K',kwfiles),)or()ifopts.get('all')oropts.get('ignore'):kwfstats+=(('I',[fforfinfilesiffnotinkwfiles]),)forchar,filenamesinkwfstats:format=(opts.get('all')orui.verbose)and'%s%%s\n'%charor'%s\n'forfinfilenames:ui.write(format%_pathto(repo,f,cwd))defshrink(ui,repo,*pats,**opts):'''revert expanded keywords in working directory Run before changing/disabling active keywords or if you experience problems with "hg import" or "hg merge". kwshrink refuses to run if given files contain local changes. '''# 3rd argument sets expansion to False_kwfwrite(ui,repo,False,*pats,**opts)defreposetup(ui,repo):ifnotrepo.local()orrepo.root.endswith('/.hg/patches'):returninc,exc=[],['.hgtags','.hg_archival.txt']forpat,optinui.configitems('keyword'):ifopt!='ignore':inc.append(pat)else:exc.append(pat)ifnotinc:returnclasskwrepo(repo.__class__):def_wreadkwct(self,filename,expand,ctx,node):'''Reads filename and returns tuple of data with keywords expanded/shrunk and count of keywords (for _overwrite).'''data=super(kwrepo,self).wread(filename)returnself._kwt.process(filename,data,expand,ctx,node)defwread(self,filename):data=super(kwrepo,self).wread(filename)ifself._kwt.matcher(filename):returnself._kwt.shrink(data)returndatadefwwrite(self,filename,data,flags=None,overwrite=False):ifnotoverwriteandself._kwt.matcher(filename):data=self._kwt.expand(filename,data,None)try:super(kwrepo,self).wwrite(filename,data,flags)except(AttributeError,TypeError):# 656e06eebda7 removed file descriptor argument# 67982d3ee76c added flags argumentsuper(kwrepo,self).wwrite(filename,data)defwwritedata(self,filename,data):ifself._kwt.matcher(filename):data=self._kwt.expand(filename,data,None)returnsuper(kwrepo,self).wwritedata(filename,data)def_commit(self,files,text,user,date,match,force,lock,wlock,force_editor,p1,p2,extra,empty_ok):'''Private commit wrapper for backwards compatibility.'''try:returnsuper(kwrepo,self).commit(files=files,text=text,user=user,date=date,match=match,force=force,lock=lock,wlock=wlock,force_editor=force_editor,p1=p1,p2=p2,extra=extra)exceptTypeError:try:returnsuper(kwrepo,self).commit(files=files,text=text,user=user,date=date,match=match,force=force,force_editor=force_editor,p1=p1,p2=p2,extra=extra,empty_ok=empty_ok)exceptTypeError:returnsuper(kwrepo,self).commit(files=files,text=text,user=user,date=date,match=match,force=force,force_editor=force_editor,p1=p1,p2=p2,extra=extra)defcommit(self,files=None,text='',user=None,date=None,match=util.always,force=False,lock=None,wlock=None,force_editor=False,p1=None,p2=None,extra={},empty_ok=False):# (w)lock arguments removed in 126f527b3ba3# so they are None or what was passed to commit# use private _(w)lock for deletion_lock=lock_wlock=wlockdelwlock,lock_p1=_p2=Nonetry:ifnot_wlock:_wlock=self.wlock()ifnot_lock:_lock=self.lock()# store and postpone commit hookscommithooks={}forname,cmdinui.configitems('hooks'):ifname.split('.',1)[0]=='commit':commithooks[name]=cmdui.setconfig('hooks',name,'')ifcommithooks:# store parents for commit hook environmentifp1isNone:_p1,_p2=repo.dirstate.parents()else:_p1,_p2=p1,p2ornullid_p1=hex(_p1)if_p2==nullid:_p2=''else:_p2=hex(_p2)node=self._commit(files,text,user,date,match,force,_lock,_wlock,force_editor,p1,p2,extra,empty_ok)# restore commit hooksforname,cmdincommithooks.iteritems():ui.setconfig('hooks',name,cmd)ifnodeisnotNone:_overwrite(ui,self,node=node)repo.hook('commit',node=node,parent1=_p1,parent2=_p2)returnnodefinally:del_wlock,_lockkwt=kwrepo._kwt=kwtemplater(ui,repo,inc,exc)if_patchfile_init:defkwpatchfile_init(self,ui,fname,missing=False):'''Monkeypatch/wrap patch.patchfile.__init__ to avoid rejects or conflicts due to expanded keywords in working dir.'''_patchfile_init(self,ui,fname,missing=missing)ifkwt.matcher(self.fname):# shrink keywords read from working dirkwshrunk=kwt.shrink(''.join(self.lines))self.lines=kwshrunk.splitlines(True)patchfile.__init__=kwpatchfile_initif_webcommands:defkwweb_rawfile(web,req,tmpl):'''Monkeypatch webcommands.rawfile so it expands keywords.'''path=web.cleanpath(req.form.get('file',[''])[0])ifnotpath:content=web.manifest(tmpl,web.changectx(req),path)req.respond(webcommands.HTTP_OK,web.ctype)returncontenttry:fctx=web.filectx(req)exceptrevlog.LookupError:content=web.manifest(tmpl,web.changectx(req),path)req.respond(webcommands.HTTP_OK,web.ctype)returncontentpath=fctx.path()text=fctx.data()ifkwt.matcher(path):text=kwt.expand(path,text,fctx.node())mt=mimetypes.guess_type(path)[0]ifmtisNoneorutil.binary(text):mt=mtor'application/octet-stream'req.respond(webcommands.HTTP_OK,mt,path,len(text))return[text]webcommands.rawfile=kwweb_rawfileelse:defkwweb_filerevision(self,fctx):'''Monkeypatch hgweb_mod.hgweb.filerevision so keywords are expanded in raw file output.'''f=fctx.path()text=fctx.data()fl=fctx.filelog()n=fctx.filenode()parity=hgweb_mod.paritygen(self.stripecount)mt=mimetypes.guess_type(f)[0]rawtext=textifkwt.matcher(f):rawtext=kwt.expand(f,text,fctx.node())ifutil.binary(text):mt=mtor'application/octet-stream'text="(binary:%s)"%mtmt=mtor'text/plain'deflines():forl,tinenumerate(text.splitlines(1)):yield{"line":t,"linenumber":"% 6d"%(l+1),"parity":parity.next()}yieldself.t("filerevision",file=f,path=hgweb_mod._up(f),text=lines(),raw=rawtext,mimetype=mt,rev=fctx.rev(),node=hex(fctx.node()),author=fctx.user(),date=fctx.date(),desc=fctx.description(),parent=self.siblings(fctx.parents()),child=self.siblings(fctx.children()),rename=self.renamelink(fl,n),permissions=fctx.manifest().flags(f))hgweb_mod.hgweb.filerevision=kwweb_filerevisionrepo.__class__=kwrepocmdtable={'kwcat':(cat,commands.table['cat'][1],_('hg kwcat [OPTION]... FILE...')),'kwdemo':(demo,[('d','default',None,_('show default keyword template maps')),('f','rcfile',[],_('read maps from rcfile'))],_('hg kwdemo [-d] [-f RCFILE] [TEMPLATEMAP]...')),'kwexpand':(expand,commands.walkopts,_('hg kwexpand [OPTION]... [FILE]...')),'kwfiles':(files,[('a','all',None,_('show keyword status flags of all files')),('i','ignore',None,_('show files excluded from expansion')),('u','untracked',None,_('additionally show untracked files')),]+commands.walkopts,_('hg kwfiles [OPTION]... [FILE]...')),'kwshrink':(shrink,commands.walkopts,_('hg kwshrink [OPTION]... [FILE]...')),}