source: trunk/lib/File.cc @ 452

Last change on this file since 452 was 452, checked in by Peter Johansson, 14 years ago

fixes #248 and refs #185

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 9.9 KB
Line 
1// $Id: File.cc 452 2007-08-17 19:03:32Z peter $
2
3/*
4  Copyright (C) 2005, 2006, 2007 Jari Häkkinen, Peter Johansson
5
6  This file is part of svndigest, http://trac.thep.lu.se/trac/svndigest
7
8  svndigest is free software; you can redistribute it and/or modify it
9  under the terms of the GNU General Public License as published by
10  the Free Software Foundation; either version 2 of the License, or
11  (at your option) any later version.
12
13  svndigest is distributed in the hope that it will be useful, but
14  WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  General Public License for more details.
17
18  You should have received a copy of the GNU General Public License
19  along with this program; if not, write to the Free Software
20  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
21  02111-1307, USA.
22*/
23
24#include "File.h"
25
26#include "Alias.h"
27#include "Configuration.h"
28#include "Date.h"
29#include "GnuplotFE.h"
30#include "html_utility.h"
31#include "HtmlStream.h"
32#include "Stats.h"
33#include "SVNblame.h"
34#include "SVNlog.h"
35
36#include <cassert>
37#include <ctime>
38#include <fstream>
39#include <iostream>
40#include <map>
41#include <string>
42#include <sys/stat.h>
43
44namespace theplu{
45namespace svndigest{
46
47
48  File::File(const u_int level, const std::string& path, 
49             const std::string& output) 
50    : Node(level,path,output) 
51  {
52    output_dir_=output;
53    if (!output_dir_.empty())
54      output_dir_+='/';
55  }
56
57
58  std::map<int, std::set<Alias> >
59  File::copyright_map(std::map<std::string, Alias>& alias) const
60  {
61    using namespace std;
62    map<int, set<Alias> > year_authors;
63    SVNlog log(path());
64
65    assert(log.author().size()==log.date().size());
66    vector<string>::const_iterator author=log.author().begin();
67    for (vector<string>::const_iterator date=log.date().begin();
68         date!=log.date().end(); ++date, ++author) {
69      time_t sec = str2time(*date);
70      tm* timeinfo = gmtime(&sec);
71
72      // find username in map of aliases
73      std::map<string,Alias>::iterator name(alias.lower_bound(*author));
74
75      // if alias exist insert alias
76      if (name != alias.end() && name->first==*author)
77        year_authors[timeinfo->tm_year].insert(name->second);
78      else {
79        // else insert user name
80        Alias a(*author,alias.size());
81        year_authors[timeinfo->tm_year].insert(a);
82        std::cerr << "svndigest: warning: no copyright alias found for `" 
83                  << *author << "'\n";
84        // insert alias to avoid multiple warnings.
85        alias.insert(name, std::make_pair(*author, a));
86      }
87    }
88    return year_authors;
89  }
90
91
92  std::string
93  File::copyright_block(const std::map<int, std::set<Alias> >& year_authors,
94                        const std::string& prefix) const
95  {
96    using namespace std;
97    stringstream ss;
98    for (map<int, set<Alias> >::const_iterator i(year_authors.begin());
99         i!=year_authors.end();) {
100      ss << prefix << "Copyright (C) "
101          << 1900+i->first;
102      map<int, set<Alias> >::const_iterator j = i;
103      assert(i!=year_authors.end());
104      while (++j!=year_authors.end() && 
105             i->second == j->second){
106        ss << ", " << 1900+(j->first);
107      }
108      // printing authors
109      std::vector<Alias> vec_alias;
110      back_insert_iterator<std::vector<Alias> > ii(vec_alias);
111      std::copy(i->second.begin(), i->second.end(), ii);
112      // sort with respect to id
113      std::sort(vec_alias.begin(), vec_alias.end(), IdCompare());
114      for (std::vector<Alias>::iterator a=vec_alias.begin();
115           a!=vec_alias.end(); ++a){
116        if (a!=vec_alias.begin())
117          ss << ",";
118        ss << " " << a->name();
119      }
120      ss << "\n";
121      i = j;
122    }
123    return ss.str();
124  }
125
126  bool File::detect_copyright(std::string& block, size_t& start_at_line,
127                              size_t& end_at_line, std::string& prefix) const
128  {
129    using namespace std;
130    ifstream is(path().c_str());
131    assert(is.good());
132    string line;
133    bool found_copyright = false;
134    bool after_copyright = false;
135    size_t line_no=0;
136    while(getline(is, line) && !after_copyright){
137      ++line_no;
138      if (found_copyright){
139        // check if line is end of copyright statement, i.e. contains
140        // no alphanumerical character (except in prefix).
141        after_copyright = true;
142        for (size_t i=0; i<line.size()&&after_copyright; ++i)
143          if (isalnum(line[i]) && !(i<prefix.size() && prefix[i]==line[i])) {
144            after_copyright = false;
145            block += line + "\n";
146          }
147        if (after_copyright)
148          end_at_line=line_no;
149      }
150      else {
151        // check whether copyright starts on this line
152        string::iterator i = search(line.begin(), line.end(), "Copyright (C)");
153        if (i!=line.end()) {
154          start_at_line=line_no;
155          prefix = line.substr(0, distance(line.begin(), i));
156          found_copyright = true;
157          block = line + "\n";
158        }
159      }
160    }
161    is.close();
162    return found_copyright;
163  }
164
165
166  std::string File::href(void) const
167  { 
168    return name()+".html"; 
169  }
170
171
172  SVNlog File::log_core(void) const
173  {
174    return SVNlog(path());
175  }
176
177
178  std::string File::node_type(void) const
179  {
180    return std::string("file");
181  }
182
183
184  std::string File::output_path(void) const
185  {
186    return output_dir()+name()+".html";
187  }
188
189
190  const Stats& File::parse(const bool verbose)
191  {
192    if (verbose)
193      std::cout << "Parsing " << path_ << std::endl; 
194    stats_.reset();
195    stats_.parse(path_);
196    return stats_;
197  }
198
199
200  void File::print_blame(std::ofstream& os) const
201  {
202    os << "<br /><h3>Blame Information</h3>";
203    os << "<table class=\"blame\">\n";
204    os << "<thead>\n";
205    os << "<tr>\n";
206    os << "<th class=\"rev\">Rev</th>\n";
207    os << "<th class=\"date\">Date</th>\n";
208    os << "<th class=\"author\">Author</th>\n";
209    os << "<th class=\"line\">Line</th>\n";
210    os << "<th></th>\n";
211    os << "</tr>\n</thead>\n";
212    os << "<tbody>\n";
213    HtmlStream hs(os);
214    SVNblame blame(path_);
215    Parser parser(path_);
216    std::vector<Parser::line_type>::const_iterator
217      line_type(parser.type().begin());
218    int last=0;
219    int first=0;
220    bool using_dates=true;
221    if (GnuplotFE::instance()->dates().empty()){
222      using_dates=false;
223      last = stats_.revision();
224    }
225    else {
226      last = Date(GnuplotFE::instance()->dates().back()).seconds();
227      first = Date(GnuplotFE::instance()->dates()[0]).seconds();
228    }
229    // color is calculated linearly on time, c = kt + m
230    // brightest color (for oldest rev in log) is set to 192.
231    double k = 192.0/(first-last);
232    double m = -last*k; 
233    while (blame.valid()) {
234      std::string color;
235      if (using_dates)
236        color = hex(static_cast<int>(k*Date(blame.date()).seconds()+m),2);
237      else
238        color = hex(static_cast<int>(k*blame.revision()+m),2);
239      os << "<tr>\n<td class=\"rev\"><font color=\"#" << color
240         << color << color << "\">" << blame.revision()
241         << "</font></td>\n<td class=\"date\"><font color=\"#" << color
242         << color << color << "\">" ;
243      hs << Date(blame.date())("%d %b %y");
244      os << "</font></td>\n<td class=\"author\">";
245      hs << blame.author();
246      os << "</td>\n<td class=\"";
247      assert(line_type!=parser.type().end());
248      if (*line_type==Parser::empty)
249        os << "line-other";
250      else if (*line_type==Parser::comment)
251        os << "line-comment";
252      else
253        os << "line-code";
254      os << "\">" << blame.line_no()+1
255         << "</td>\n<td>";
256      hs << blame.line();
257      os << "</td>\n</tr>\n";
258      blame.next_line();
259      ++line_type;
260    }
261    os << "</tbody>\n";
262    os << "</table>\n";
263  }
264
265
266  void File::print_copyright(std::map<std::string, Alias>& alias, 
267                             bool verbose) const 
268  {
269    if (ignore())
270      return;
271
272    std::string old_block;
273    size_t start_line=0;
274    size_t end_line=0;
275    std::string prefix;
276    if (!detect_copyright(old_block, start_line, end_line, prefix)){
277      if (Configuration::instance().missing_copyright_warning())
278        std::cerr << "svndigest: warning: no copyright statement found in `" 
279                  << path_ << "'\n";
280      return;
281    }
282    std::map<int, std::set<Alias> > map=copyright_map(alias);
283    std::string new_block = copyright_block(map, prefix);
284    if (old_block==new_block)
285      return;
286    if (verbose)
287      std::cout << "Updating copyright in " << path_ << std::endl; 
288    update_copyright(new_block, start_line, end_line);
289  }
290
291
292  void File::print_core(const bool verbose) const 
293  {
294  }
295
296
297  void File::print_core(const std::string& user, const std::string& line_type,
298                        const SVNlog& log) const 
299  {
300    std::string outpath = user+"/"+line_type+"/"+local_path();
301    std::string imagefile = "images/"+line_type+"/"+local_path_+".png";
302    std::string html_name(outpath + ".html");
303    std::ofstream os(html_name.c_str());
304    print_header(os, name(), level_+2, user, line_type, local_path()+".html");
305    path_anchor(os);
306
307    os << "<p class=\"plot\">\n<img src='"; 
308    for (size_t i=0; i<level_; ++i)
309      os << "../";
310    os << "../../";
311    if (user=="all")
312      os << stats_.plot(imagefile,line_type);
313    else
314      os << imagefile;
315    os << "' alt='[plot]' />\n</p>";
316
317    print_author_summary(os, line_type, log);
318    os << "\n";
319
320    print_blame(os);
321
322    print_footer(os);
323    os.close(); 
324  }
325
326  void File::update_copyright(const std::string& new_block,
327                              size_t start_at_line, size_t end_at_line) const
328  {
329    // Code copied from Gnuplot -r70
330    char tmpname[]="/tmp/svndigestXXXXXX";
331    int fd=mkstemp(tmpname);  // mkstemp return a file descriptor
332    if (fd == -1)
333      throw std::runtime_error(std::string("Failed to get unique filename: ") +
334                               tmpname);
335    // Jari would like to do something like 'std::ofstream tmp(fd);'
336    // but has to settle for (which is stupid since the file is
337    // already open for writing.
338    std::ofstream tmp(tmpname);
339
340    using namespace std;
341    ifstream is(path().c_str());
342    assert(is.good());
343    string line;
344    // Copy lines before block
345    for (size_t i=1; i<start_at_line; ++i){
346      assert(is.good());
347      getline(is, line);
348      tmp << line << "\n";
349    }
350    // Printing copyright statement
351    tmp << new_block;
352    // Ignore old block lines
353    for (size_t i=start_at_line; i<end_at_line; ++i){
354      assert(is.good());
355      getline(is, line);
356    }
357    // Copy lines after block
358    while(getline(is, line))
359      tmp << line << "\n";
360
361    is.close();
362    tmp.close();
363    close(fd);
364    // get file permission
365    struct stat nodestat;
366    stat(path().c_str(),&nodestat);
367   
368    // finally move printed temporary file to original file
369    rename(tmpname, path().c_str());
370    chmod(path().c_str(), nodestat.st_mode);
371  }
372
373
374}} // end of namespace svndigest and namespace theplu
Note: See TracBrowser for help on using the repository browser.