Loading...
Helix SwarmHelix Swarm
Loading...

htmlmessage.py

  • //
  • guest/
  • matthew_janulewicz/
  • p4spam-1.1/
  • pylib/
  • p4spam/
  • htmlmessage.py #6
  • View
  • Commits
  • Open Download .zip Download (11 KB) 
  1. ##
  2. ## Copyright (c) 2006 Jason Dillon
  3. ##
  4. ## Licensed under the Apache License, Version 2.0 (the "License");
  5. ## you may not use this file except in compliance with the License.
  6. ## You may obtain a copy of the License at
  7. ##
  8. ##     http://www.apache.org/licenses/LICENSE-2.0
  9. ##
  10. ## Unless required by applicable law or agreed to in writing, software
  11. ## distributed under the License is distributed on an "AS IS" BASIS,
  12. ## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. ## See the License for the specific language governing permissions and
  14. ## limitations under the License.
  15. ##
  16.  
  17. ##
  18. ## $Id: htmlmessage.py 82 2009-08-26 09:26:36Z mindwanderer $
  19. ##
  20.  
  21. from p4spam import config, jiralinker
  22. from p4spam.message import MessageBuilder
  23.  
  24. class HtmlMessageBuilder(MessageBuilder):
  25.     def __init__(this, info):
  26.         MessageBuilder.__init__(this, info)
  27.         this.contentType = 'html'
  28.     
  29.     def escapeLine(this, line):
  30.         ##
  31.         ## HACK: Need a library to handle all this mess
  32.         ##
  33.         line = line.replace('&', '&')
  34.         line = line.replace('>', '>')
  35.         line = line.replace('<', '&lt;')
  36.         line = line.replace('\t', '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;')
  37.         
  38.         ##
  39.         ## HACK: Trim the line here too... :-(
  40.         ##
  41.         
  42.         l = len(line)
  43.         m = config.MAX_DIFF_LINE_LENGTH
  44.         if l > m:
  45.             this.log.warning("Diff line longer than %s; truncating %s remaining characters" % (m, l - m))
  46.             line = line[:m]
  47.             
  48.         return line
  49.  
  50.     # parses the Description of the changelist. Separate from above, generic escapeLine because
  51.     # perhaps we want to display the entire Description no matter the length and not invoke
  52.     # MAX_DIFF_LINE_LENGTH to cut it off
  53.     def escapeDescLine(this, line):
  54.         ##
  55.         ## HACK: Need a library to handle all this mess
  56.         ##
  57.         line = line.replace('&', '&amp;')
  58.         line = line.replace('>', '&gt;')
  59.         line = line.replace('<', '&lt;')
  60.         line = line.replace('\t', '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;')
  61.         
  62.         return line
  63.  
  64.     def generatePathAnchor(this, path):
  65.         anchor = path
  66.         
  67.         # Condense the path...
  68.         anchor = anchor.replace('/', '')
  69.         anchor = anchor.replace('.', '')
  70.         anchor = anchor.replace(' ', '')
  71.         
  72.         return anchor
  73.     
  74.     def writeDocument(this, buff, recipient):
  75.         buff.writeln('<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"')
  76.         buff.writeln('"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">')
  77.         buff.writeln('<html xmlns="http://www.w3.org/1999/xhtml">')
  78.         
  79.         this.writeHeader(buff)
  80.         this.writeBody(buff, recipient)
  81.         
  82.         buff.writeln('</html>')
  83.         
  84.     def writeHeader(this, buff):
  85.         buff.writeln('<head>')
  86.         buff.writeln("<style type=\"text/css\"><!--\n%s\n--></style>" % config.HTML_STYLE)
  87.         
  88.         # Write user-header
  89.         if config.USER_HEADER != None:
  90.             buff.writeln(config.USER_HEADER)
  91.         
  92.         buff.writeln("<title>%s</title>" % this.getTitle())
  93.         buff.writeln('</head>')
  94.     
  95.     def writeOverview(this, buff):
  96.         # Change description header
  97.         buff.writeln('<table border="0" cellspacing="0" cellpadding="3" width="100%">')
  98.         buff.writeln("<tr><td width=\"70\"><b>Change</b></td><td>%s</td></tr>" % this.info.getChange())
  99.         buff.writeln("<tr><td><b>Author</b></td><td>%s</td></tr>" % this.info.getAuthor())
  100.         buff.writeln("<tr><td><b>Client</b></td><td>%s</td></tr>" % this.info.getClient())
  101.         buff.writeln("<tr><td><b>Date</b></td><td>%s</td></tr>" % this.info.getDateTime())
  102.         buff.writeln('</table>')
  103.         buff.writeln()
  104.         
  105.         # Change description/comment
  106.         buff.writeln('<h3>Description</h3>')
  107.         buff.writeln('<pre>')
  108.         
  109.         lines = this.info.getComments()
  110.         for line in lines:
  111.             line = this.escapeDescLine(line)
  112.             line = jiralinker.render(line)
  113.             buff.writeln("%s<br/>" % line)
  114.         
  115.         buff.writeln('</pre>')
  116.         buff.writeln()
  117.         
  118.         # Link to change description URL
  119.         buff.writeln('<h3>URL</h3>')
  120.         url = config.CHANGE_LIST_URL % this.info.getChange()
  121.         buff.writeln("<a href=\"%s\">%s</a>" % (url, url))
  122.         
  123.         # If this change fixes a job, include the job detail
  124.         fixes = this.info.getJobsFixed()
  125.         if len(fixes) != 0:
  126.             buff.writeln('<h3>Jobs Fixed</h3>')
  127.             buff.writeln('<ul>')
  128.             
  129.             for fix in fixes:
  130.                 # Link to P4Web if configured
  131.                 if config.P4WEB_JOB_VIEW_URL != None:
  132.                     fixurl = config.P4WEB_JOB_VIEW_URL % fix.name
  133.                     fixlink = '<a href="%s">%s</a>' % (fixurl, fix.name)
  134.                 else:
  135.                     fixlink = fix.name
  136.                 
  137.                 buff.write('<li>%s on %s by %s %s</li>' % (fixlink, fix.date, fix.author, fix.status))
  138.                 
  139.                 ##
  140.                 ## NOTE: Ignore the Job description for now.
  141.                 ##
  142.             
  143.             buff.writeln('</ul>')
  144.     
  145.     def writeFileActionTOC(this, buff):
  146.         actions = ('edit', 'add', 'delete', 'branch', 'integrate', 'purge', 'move/delete', 'move/add', 'import')
  147.         
  148.         actionLables = {
  149.             'edit':         'Edited Files',
  150.             'add':          'Added Files',
  151.             'delete':       'Deleted Files',
  152.             'branch':       'Branched Files',
  153.             'integrate':    'Integrated Files',
  154.             'purge':        'Purged Files',
  155.             'move/delete':  'Moved Files (delete)',
  156.             'move/add':     'Moved Files (add)',
  157. 	    'import':       'Imported Files (add from remote depot)'
  158.         }
  159.         
  160.         # Init the map
  161.         actionToFilesMap = {}
  162.         for a in actions:
  163.             actionToFilesMap[a] = []
  164.         
  165.         # Fill the map
  166.         for f in this.info.getAffectedFiles():
  167.             actionToFilesMap[f.action].append(f)
  168.         
  169.         this.log.debug("Action to files map: %s" % (actionToFilesMap))
  170.         
  171.         for action in actions:
  172.             files = actionToFilesMap[action]
  173.             if len(files) == 0:
  174.                 # Skip section if there are no files
  175.                 this.log.debug("Skipping '%s' section; no files" % action)
  176.                 continue
  177.             
  178.             buff.writeln("<h3>%s</h3>" % actionLables[action])
  179.             buff.writeln('<ul>')
  180.  
  181.             fileslimit = 0
  182.  
  183.             for f in files:
  184.                 buff.writeln('<li>')
  185.                 
  186.                 anchor = this.generatePathAnchor(f.path)
  187.                 pathspec = "%s#%s" % (f.path, f.rev)
  188.                 link = "<a href=\"%s\">[history]</a>" % (config.FILE_HISTORY_URL % f.path)
  189.                 buff.writeln("<a href=\"#%s\">%s</a>&nbsp;%s" % (anchor, pathspec, link))
  190.                 buff.writeln('</li>')
  191.  
  192.                 fileslimit = fileslimit+1
  193.  
  194. 		if fileslimit >= config.MAX_FILE_LIST:
  195. 			buff.write('<strong class="error">')
  196. 			buff.write('File list truncated at %s by configuration' % config.MAX_FILE_LIST)
  197. 			buff.write('</strong>') 
  198. 			break
  199.  
  200.             buff.writeln('</ul>')
  201.             buff.writeln()
  202.     
  203.     def writeBody(this, buff, recipient):
  204.         buff.writeln('<body>')
  205.         
  206.         # Write user-body-header
  207.         if config.USER_BODY_HEADER != None:
  208.             buff.writeln(config.USER_BODY_HEADER)
  209.             
  210.         buff.writeln('<div id="msg">')
  211.         
  212.         this.writeOverview(buff)
  213.         buff.writeln()
  214.         
  215.         this.writeFileActionTOC(buff)
  216.         buff.writeln('</div>')
  217.         buff.writeln()
  218.         
  219.         this.writeDifferences(buff, recipient)
  220.         buff.writeln()
  221.         
  222.         # Write user-body-footer
  223.         if config.USER_BODY_FOOTER != None:
  224.             buff.writeln(config.USER_BODY_FOOTER)
  225.         
  226.         buff.writeln('</body>')
  227.     
  228.     def writeDifferences(this, buff, recipient):
  229.         buff.writeln('<div id="patch">')
  230.         buff.writeln('<h3>Differences</h3>')
  231.        
  232. 	fileslimit = 0
  233.  
  234.         # log the recipient into p4 as the admin so we can masquerade as him/her
  235. 	loginresult = this.p4.raw('login', recipient)
  236.  
  237.         for diff in this.info.getDifferences():
  238.             # Write the anchor
  239.             anchor = this.generatePathAnchor(diff.path)
  240.             buff.writeln("<a id=\"%s\"></a>" % anchor)
  241.             
  242.             buff.writeln('<div class="modfile">')
  243.             buff.writeln("<h4>%s#%s (%s)</h4>" % (diff.path, diff.rev, diff.filetype))
  244.             
  245. 	    # this is where we'll take the recipient then decide whether or not they have
  246. 	    # permissions to view this diff
  247. 	    
  248. 	    # try to print the file as the recipient
  249.             syncresult = this.p4.raw('-u', recipient, 'print', diff.path)
  250. 	    
  251. 	    # if the 'p4 print' results are empty, it means the output went to stderr, which
  252. 	    # is to say this user doesn't have access to that file
  253. 	    if len(syncresult) == 0:
  254.                 buff.write('<strong class="error">')
  255.                 buff.write("You do not have appropriate Perforce permissions to view this diff!")
  256.                 buff.write('</strong>')
  257.                 buff.writeln('</div>')
  258.  
  259. 		# Allow some filetypes to not diff
  260.     
  261. 		if diff.filetype in config.DISABLE_DIFF_FOR_FILETYPE:
  262. 		    buff.write('<strong class="error">')
  263. 		    buff.write('Diff disabled for type %s by configuration' % diff.filetype)
  264. 		    buff.write('</strong>')
  265. 		    
  266. 		else:
  267. 		    buff.writeln('<pre class="diff">')
  268. 		    
  269. 		    i = 0
  270. 		    maxlines = config.MAX_DIFF_LINES
  271. 		    style = None
  272. 		    lastStyle = None
  273. 		    
  274. 		    for line in diff.lines:
  275. 			line = this.escapeLine(line)
  276. 			
  277. 			if line.startswith('@@'):
  278. 			    style = 'lines'
  279. 			elif line.startswith('+'):
  280. 			    style = 'add'
  281. 			elif line.startswith('-'):
  282. 			    style = 'rem'
  283. 			else:
  284. 			    style = 'cx'
  285. 			
  286. 			# Only write style spans if the sytle was changed
  287. 			if style != lastStyle:
  288. 			    if lastStyle != None:
  289. 				buff.write('</span>')
  290. 			    buff.write('<span class="%s">' % style)
  291. 			
  292. 			buff.write(line)
  293. 			
  294. 			lastStyle = style
  295. 			
  296. 			i = i + 1
  297. 			if i >= maxlines:
  298. 			    break
  299.     
  300. 		    # Need to close up the last span
  301. 		    buff.writeln('</span>')
  302. 		    
  303. 		    buff.writeln('</pre>')
  304. 		    
  305. 		    # If we truncated, then spit out a message
  306. 		    totallines = len(diff.lines)
  307. 		    if i >= maxlines and totallines != maxlines:
  308. 			buff.write('<strong class="error">')
  309. 			buff.write("Truncated at %s lines; %s more skipped" % (maxlines, totallines - maxlines))
  310. 			buff.writeln('</strong>')
  311. 	       
  312. 		buff.writeln('</div>')
  313.     
  314.             fileslimit = fileslimit + 1
  315.     
  316.             if fileslimit >= config.MAX_DIFF_FILES:
  317.                 buff.write('<strong class="error">')
  318.                 buff.write('Diff section truncated at %s files by configuration' % config.MAX_DIFF_FILES)
  319.                 buff.write('</strong>')
  320.                 break
  321.     
  322.         buff.writeln('</div>')
# Change User Description Committed
#6 8146 Matthew Janulewicz Fixing display for 'import' transaction type. 13 years ago
#5 8134 Matthew Janulewicz Adding 'import' transaction type (branch from remote depot.) 13 years ago
#4 7833 Matthew Janulewicz P4Spam now obeys 'p4 protects' and will not expose code diffs to subscribers that do not h...ave the proper p4 permissions to view that diff. « 14 years ago
#3 7776 Matthew Janulewicz Now allows changelist description of any length and does not cut off each line at MAX_DIFF..._LINE_LENGTH. « 15 years ago
#2 7732 Matthew Janulewicz Adding ability for P4Spam to detect and correcty categorize P4 2009.1's new 'move/add' and... 'move/delete' file operations. « 15 years ago
#1 7731 Matthew Janulewicz Adding P4Spam 1.1 code from http://p4spam.sourceforge.net/wiki/Main_Page

"P4Spam is a P...erforce change review daemon which spits out sexy HTML-styled notification emails." «		 15 years ago