1extern crate ansi_term;
2extern crate chrono;
3#[macro_use]
4extern crate clap;
5extern crate colorparse;
6extern crate git2;
7extern crate isatty;
8#[macro_use]
9extern crate quick_error;
10extern crate tempdir;
11
12use std::env;
13use std::ffi::{OsStr, OsString};
14use std::fmt::Write as FmtWrite;
15use std::fs::File;
16use std::io::Read;
17use std::io::Write as IoWrite;
18use std::process::Command;
19use ansi_term::Style;
20use chrono::offset::TimeZone;
21use clap::{App, AppSettings, Arg, ArgGroup, ArgMatches, SubCommand};
22use git2::{Config, Commit, Diff, Object, ObjectType, Oid, Reference, Repository, TreeBuilder};
23use tempdir::TempDir;
24
25quick_error! {
26 #[derive(Debug)]
27 enum Error {
28 Git2(err: git2::Error) {
29 from()
30 cause(err)
31 display("{}", err)
32 }
33 IO(err: std::io::Error) {
34 from()
35 cause(err)
36 display("{}", err)
37 }
38 Msg(msg: String) {
39 from()
40 from(s: &'static str) -> (s.to_string())
41 description(msg)
42 display("{}", msg)
43 }
44 Utf8Error(err: std::str::Utf8Error) {
45 from()
46 cause(err)
47 display("{}", err)
48 }
49 }
50}
51
52type Result<T> = std::result::Result<T, Error>;
53
54const COMMIT_MESSAGE_COMMENT: &'static str = "
55# Please enter the commit message for your changes. Lines starting
56# with '#' will be ignored, and an empty message aborts the commit.
57";
58const COVER_LETTER_COMMENT: &'static str = "
59# Please enter the cover letter for your changes. Lines starting
60# with '#' will be ignored, and an empty message aborts the change.
61";
62const REBASE_COMMENT: &'static str = "\
63#
64# Commands:
65# p, pick = use commit
66# r, reword = use commit, but edit the commit message
67# e, edit = use commit, but stop for amending
68# s, squash = use commit, but meld into previous commit
69# f, fixup = like \"squash\", but discard this commit's log message
70# x, exec = run command (the rest of the line) using shell
71# d, drop = remove commit
72#
73# These lines can be re-ordered; they are executed from top to bottom.
74#
75# If you remove a line here THAT COMMIT WILL BE LOST.
76#
77# However, if you remove everything, the rebase will be aborted.
78";
79const SCISSOR_LINE: &'static str = "\
80# ------------------------ >8 ------------------------";
81const SCISSOR_COMMENT: &'static str = "\
82# Do not touch the line above.
83# Everything below will be removed.
84";
85
86const SHELL_METACHARS: &'static str = "|&;<>()$`\\\"' \t\n*?[#~=%";
87
88const SERIES_PREFIX: &'static str = "refs/heads/git-series/";
89const SHEAD_REF: &'static str = "refs/SHEAD";
90const STAGED_PREFIX: &'static str = "refs/git-series-internals/staged/";
91const WORKING_PREFIX: &'static str = "refs/git-series-internals/working/";
92
93const GIT_FILEMODE_BLOB: u32 = 0o100644;
94const GIT_FILEMODE_COMMIT: u32 = 0o160000;
95
96fn zero_oid() -> Oid {
97 Oid::from_bytes(b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00").unwrap()
98}
99
100fn peel_to_commit(r: Reference) -> Result<Commit> {
101 Ok(try!(try!(r.peel(ObjectType::Commit)).into_commit().map_err(|obj| format!("Internal error: expected a commit: {}", obj.id()))))
102}
103
104fn commit_obj_summarize_components(commit: &mut Commit) -> Result<(String, String)> {
105 let short_id_buf = try!(commit.as_object().short_id());
106 let short_id = short_id_buf.as_str().unwrap();
107 let summary = String::from_utf8_lossy(commit.summary_bytes().unwrap());
108 Ok((short_id.to_string(), summary.to_string()))
109}
110
111fn commit_summarize_components(repo: &Repository, id: Oid) -> Result<(String, String)> {
112 let mut commit = try!(repo.find_commit(id));
113 commit_obj_summarize_components(&mut commit)
114}
115
116fn commit_obj_summarize(commit: &mut Commit) -> Result<String> {
117 let (short_id, summary) = try!(commit_obj_summarize_components(commit));
118 Ok(format!("{} {}", short_id, summary))
119}
120
121fn commit_summarize(repo: &Repository, id: Oid) -> Result<String> {
122 let mut commit = try!(repo.find_commit(id));
123 commit_obj_summarize(&mut commit)
124}
125
126fn notfound_to_none<T>(result: std::result::Result<T, git2::Error>) -> Result<Option<T>> {
127 match result {
128 Err(ref e) if e.code() == git2::ErrorCode::NotFound => Ok(None),
129 Err(e) => Err(e.into()),
130 Ok(x) => Ok(Some(x)),
131 }
132}
133
134// If current_id_opt is Some, acts like reference_matching. If current_id_opt is None, acts like
135// reference.
136fn reference_matching_opt<'repo>(repo: &'repo Repository, name: &str, id: Oid, force: bool, current_id_opt: Option<Oid>, log_message: &str) -> Result<Reference<'repo>> {
137 match current_id_opt {
138 None => Ok(try!(repo.reference(name, id, force, log_message))),
139 Some(current_id) => Ok(try!(repo.reference_matching(name, id, force, current_id, log_message))),
140 }
141}
142
143fn parents_from_ids(repo: &Repository, mut parents: Vec<Oid>) -> Result<Vec<Commit>> {
144 parents.sort();
145 parents.dedup();
146 parents.drain(..).map(|id| Ok(try!(repo.find_commit(id)))).collect::<Result<Vec<Commit>>>()
147}
148
149struct Internals<'repo> {
150 staged: TreeBuilder<'repo>,
151 working: TreeBuilder<'repo>,
152}
153
154impl<'repo> Internals<'repo> {
155 fn read(repo: &'repo Repository) -> Result<Self> {
156 let shead = try!(repo.find_reference(SHEAD_REF));
157 let series_name = try!(shead_series_name(&shead));
158 let mut internals = try!(Internals::read_series(repo, &series_name));
159 try!(internals.update_series(repo));
160 Ok(internals)
161 }
162
163 fn read_series(repo: &'repo Repository, series_name: &str) -> Result<Self> {
164 let committed_id = try!(notfound_to_none(repo.refname_to_id(&format!("{}{}", SERIES_PREFIX, series_name))));
165 let maybe_get_ref = |prefix: &str| -> Result<TreeBuilder<'repo>> {
166 match try!(notfound_to_none(repo.refname_to_id(&format!("{}{}", prefix, series_name)))).or(committed_id) {
167 Some(id) => {
168 let c = try!(repo.find_commit(id));
169 let t = try!(c.tree());
170 Ok(try!(repo.treebuilder(Some(&t))))
171 }
172 None => Ok(try!(repo.treebuilder(None))),
173 }
174 };
175 Ok(Internals {
176 staged: try!(maybe_get_ref(STAGED_PREFIX)),
177 working: try!(maybe_get_ref(WORKING_PREFIX)),
178 })
179 }
180
181 fn exists(repo: &'repo Repository, series_name: &str) -> Result<bool> {
182 for prefix in [SERIES_PREFIX, STAGED_PREFIX, WORKING_PREFIX].iter() {
183 let prefixed_name = format!("{}{}", prefix, series_name);
184 if try!(notfound_to_none(repo.refname_to_id(&prefixed_name))).is_some() {
185 return Ok(true);
186 }
187 }
188 Ok(false)
189 }
190
191 // Returns true if it had anything to delete.
192 fn delete(repo: &'repo Repository, series_name: &str) -> Result<bool> {
193 let mut deleted_any = false;
194 for prefix in [STAGED_PREFIX, WORKING_PREFIX].iter() {
195 let prefixed_name = format!("{}{}", prefix, series_name);
196 if let Some(mut r) = try!(notfound_to_none(repo.find_reference(&prefixed_name))) {
197 try!(r.delete());
198 deleted_any = true;
199 }
200 }
201 Ok(deleted_any)
202 }
203
204 fn update_series(&mut self, repo: &'repo Repository) -> Result<()> {
205 let head_id = try!(repo.refname_to_id("HEAD"));
206 try!(self.working.insert("series", head_id, GIT_FILEMODE_COMMIT as i32));
207 Ok(())
208 }
209
210 fn write(&self, repo: &'repo Repository) -> Result<()> {
211 let config = try!(repo.config());
212 let author = try!(get_signature(&config, "AUTHOR"));
213 let committer = try!(get_signature(&config, "COMMITTER"));
214
215 let shead = try!(repo.find_reference(SHEAD_REF));
216 let series_name = try!(shead_series_name(&shead));
217 let maybe_commit = |prefix: &str, tb: &TreeBuilder| -> Result<()> {
218 let tree_id = try!(tb.write());
219 let refname = format!("{}{}", prefix, series_name);
220 let old_commit_id = try!(notfound_to_none(repo.refname_to_id(&refname)));
221 if let Some(id) = old_commit_id {
222 let c = try!(repo.find_commit(id));
223 if c.tree_id() == tree_id {
224 return Ok(());
225 }
226 }
227 let tree = try!(repo.find_tree(tree_id));
228 let mut parents = Vec::new();
229 // Include all commits from tree, to keep them reachable and fetchable. Include base,
230 // because series might not have it as an ancestor; we don't enforce that until commit.
231 for e in tree.iter() {
232 if e.kind() == Some(ObjectType::Commit) {
233 parents.push(e.id());
234 }
235 }
236 let parents = try!(parents_from_ids(repo, parents));
237 let parents_ref: Vec<&_> = parents.iter().collect();
238 let commit_id = try!(repo.commit(None, &author, &committer, &refname, &tree, &parents_ref));
239 try!(repo.reference_ensure_log(&refname));
240 try!(reference_matching_opt(repo, &refname, commit_id, true, old_commit_id, &format!("commit: {}", refname)));
241 Ok(())
242 };
243 try!(maybe_commit(STAGED_PREFIX, &self.staged));
244 try!(maybe_commit(WORKING_PREFIX, &self.working));
245 Ok(())
246 }
247}
248
249fn diff_empty(diff: &Diff) -> bool {
250 diff.deltas().len() == 0
251}
252
253fn add(repo: &Repository, m: &ArgMatches) -> Result<()> {
254 let mut internals = try!(Internals::read(repo));
255 for file in m.values_of_os("change").unwrap() {
256 match try!(internals.working.get(file)) {
257 Some(entry) => { try!(internals.staged.insert(file, entry.id(), entry.filemode())); }
258 None => {
259 if try!(internals.staged.get(file)).is_some() {
260 try!(internals.staged.remove(file));
261 }
262 }
263 }
264 }
265 internals.write(repo)
266}
267
268fn unadd(repo: &Repository, m: &ArgMatches) -> Result<()> {
269 let shead = try!(repo.find_reference(SHEAD_REF));
270 let started = {
271 let shead_target = try!(shead.symbolic_target().ok_or("SHEAD not a symbolic reference"));
272 try!(notfound_to_none(repo.find_reference(shead_target))).is_some()
273 };
274
275 let mut internals = try!(Internals::read(repo));
276 if started {
277 let shead_commit = try!(peel_to_commit(shead));
278 let shead_tree = try!(shead_commit.tree());
279
280 for file in m.values_of("change").unwrap() {
281 match shead_tree.get_name(file) {
282 Some(entry) => {
283 try!(internals.staged.insert(file, entry.id(), entry.filemode()));
284 }
285 None => { try!(internals.staged.remove(file)); }
286 }
287 }
288 } else {
289 for file in m.values_of("change").unwrap() {
290 try!(internals.staged.remove(file))
291 }
292 }
293 internals.write(repo)
294}
295
296fn shead_series_name(shead: &Reference) -> Result<String> {
297 let shead_target = try!(shead.symbolic_target().ok_or("SHEAD not a symbolic reference"));
298 if !shead_target.starts_with(SERIES_PREFIX) {
299 return Err(format!("SHEAD does not start with {}", SERIES_PREFIX).into());
300 }
301 Ok(shead_target[SERIES_PREFIX.len()..].to_string())
302}
303
304fn series(out: &mut Output, repo: &Repository) -> Result<()> {
305 let mut refs = Vec::new();
306 for prefix in [SERIES_PREFIX, STAGED_PREFIX, WORKING_PREFIX].iter() {
307 let l = prefix.len();
308 for r in try!(repo.references_glob(&[prefix, "*"].concat())).names() {
309 refs.push(try!(r)[l..].to_string());
310 }
311 }
312 let shead_target = if let Some(shead) = try!(notfound_to_none(repo.find_reference(SHEAD_REF))) {
313 Some(try!(shead_series_name(&shead)).to_string())
314 } else {
315 None
316 };
317 refs.extend(shead_target.clone().into_iter());
318 refs.sort();
319 refs.dedup();
320
321 let config = try!(try!(repo.config()).snapshot());
322 try!(out.auto_pager(&config, "branch", false));
323 let color_current = try!(out.get_color(&config, "branch", "current", "green"));
324 let color_plain = try!(out.get_color(&config, "branch", "plain", "normal"));
325 for name in refs.iter() {
326 let (star, color) = if Some(name) == shead_target.as_ref() {
327 ('*', color_current)
328 } else {
329 (' ', color_plain)
330 };
331 let new = if try!(notfound_to_none(repo.refname_to_id(&format!("{}{}", SERIES_PREFIX, name)))).is_none() {
332 " (new, no commits yet)"
333 } else {
334 ""
335 };
336 try!(writeln!(out, "{} {}{}", star, color.paint(name as &str), new));
337 }
338 if refs.is_empty() {
339 try!(writeln!(out, "No series; use \"git series start <name>\" to start"));
340 }
341 Ok(())
342}
343
344fn start(repo: &Repository, m: &ArgMatches) -> Result<()> {
345 let head = try!(repo.head());
346 let head_commit = try!(peel_to_commit(head));
347 let head_id = head_commit.as_object().id();
348
349 let name = m.value_of("name").unwrap();
350 if try!(Internals::exists(repo, name)) {
351 return Err(format!("Series {} already exists.\nUse checkout to resume working on an existing patch series.", name).into());
352 }
353 let prefixed_name = &[SERIES_PREFIX, name].concat();
354 try!(repo.reference_symbolic(SHEAD_REF, &prefixed_name, true, &format!("git series start {}", name)));
355
356 let internals = try!(Internals::read(repo));
357 try!(internals.write(repo));
358
359 // git status parses this reflog string; the prefix must remain "checkout: moving from ".
360 try!(repo.reference("HEAD", head_id, true, &format!("checkout: moving from {} to {} (git series start {})", head_id, head_id, name)));
361 println!("HEAD is now detached at {}", try!(commit_summarize(&repo, head_id)));
362 Ok(())
363}
364
365fn checkout_tree(repo: &Repository, treeish: &Object) -> Result<()> {
366 let mut conflicts = Vec::new();
367 let mut dirty = Vec::new();
368 let result = {
369 let mut opts = git2::build::CheckoutBuilder::new();
370 opts.safe();
371 opts.notify_on(git2::CHECKOUT_NOTIFICATION_CONFLICT | git2::CHECKOUT_NOTIFICATION_DIRTY);
372 opts.notify(|t, path, _, _, _| {
373 let path = path.unwrap().to_owned();
374 if t == git2::CHECKOUT_NOTIFICATION_CONFLICT {
375 conflicts.push(path);
376 } else if t == git2::CHECKOUT_NOTIFICATION_DIRTY {
377 dirty.push(path);
378 }
379 true
380 });
381 if isatty::stdout_isatty() {
382 opts.progress(|_, completed, total| {
383 let total = total.to_string();
384 print!("\rChecking out files: {1:0$}/{2}", total.len(), completed, total);
385 });
386 }
387 repo.checkout_tree(treeish, Some(&mut opts))
388 };
389 match result {
390 Err(ref e) if e.code() == git2::ErrorCode::Conflict => {
391 let mut msg = String::new();
392 writeln!(msg, "error: Your changes to the following files would be overwritten by checkout:").unwrap();
393 for path in conflicts {
394 writeln!(msg, " {}", path.to_string_lossy()).unwrap();
395 }
396 writeln!(msg, "Please, commit your changes or stash them before you switch series.").unwrap();
397 return Err(msg.into());
398 }
399 _ => try!(result),
400 }
401 println!("");
402 if !dirty.is_empty() {
403 let mut stderr = std::io::stderr();
404 writeln!(stderr, "Files with changes unaffected by checkout:").unwrap();
405 for path in dirty {
406 writeln!(stderr, " {}", path.to_string_lossy()).unwrap();
407 }
408 }
409 Ok(())
410}
411
412fn checkout(repo: &Repository, m: &ArgMatches) -> Result<()> {
413 match repo.state() {
414 git2::RepositoryState::Clean => (),
415 s => { return Err(format!("{:?} in progress; cannot checkout patch series", s).into()); }
416 }
417 let name = m.value_of("name").unwrap();
418 if !try!(Internals::exists(repo, name)) {
419 return Err(format!("Series {} does not exist.\nUse \"git series start <name>\" to start a new patch series.", name).into());
420 }
421
422 let internals = try!(Internals::read_series(repo, name));
423 let new_head_id = try!(try!(internals.working.get("series")).ok_or(format!("Could not find \"series\" in \"{}\"", name))).id();
424 let new_head = try!(repo.find_commit(new_head_id)).into_object();
425
426 try!(checkout_tree(repo, &new_head));
427
428 let head = try!(repo.head());
429 let head_commit = try!(peel_to_commit(head));
430 let head_id = head_commit.as_object().id();
431 println!("Previous HEAD position was {}", try!(commit_summarize(&repo, head_id)));
432
433 let prefixed_name = &[SERIES_PREFIX, name].concat();
434 try!(repo.reference_symbolic(SHEAD_REF, &prefixed_name, true, &format!("git series checkout {}", name)));
435 try!(internals.write(repo));
436
437 // git status parses this reflog string; the prefix must remain "checkout: moving from ".
438 try!(repo.reference("HEAD", new_head_id, true, &format!("checkout: moving from {} to {} (git series checkout {})", head_id, new_head_id, name)));
439 println!("HEAD is now detached at {}", try!(commit_summarize(&repo, new_head_id)));
440
441 Ok(())
442}
443
444fn base(repo: &Repository, m: &ArgMatches) -> Result<()> {
445 let mut internals = try!(Internals::read(repo));
446
447 let current_base_id = match try!(internals.working.get("base")) {
448 Some(entry) => entry.id(),
449 _ => zero_oid(),
450 };
451
452 if !m.is_present("delete") && !m.is_present("base") {
453 if current_base_id.is_zero() {
454 return Err("Patch series has no base set".into());
455 } else {
456 println!("{}", current_base_id);
457 return Ok(());
458 }
459 }
460
461 let new_base_id = if m.is_present("delete") {
462 zero_oid()
463 } else {
464 let base = m.value_of("base").unwrap();
465 let base_object = try!(repo.revparse_single(base));
466 let base_id = base_object.id();
467 let s_working_series = try!(try!(internals.working.get("series")).ok_or("Could not find entry \"series\" in working vesion of current series"));
468 if base_id != s_working_series.id() && !try!(repo.graph_descendant_of(s_working_series.id(), base_id)) {
469 return Err(format!("Cannot set base to {}: not an ancestor of the patch series {}", base, s_working_series.id()).into());
470 }
471 base_id
472 };
473
474 if current_base_id == new_base_id {
475 return Err("Base unchanged".into());
476 }
477
478 if !current_base_id.is_zero() {
479 println!("Previous base was {}", try!(commit_summarize(&repo, current_base_id)));
480 }
481
482 if new_base_id.is_zero() {
483 try!(internals.working.remove("base"));
484 try!(internals.write(repo));
485 println!("Cleared patch series base");
486 } else {
487 try!(internals.working.insert("base", new_base_id, GIT_FILEMODE_COMMIT as i32));
488 try!(internals.write(repo));
489 println!("Set patch series base to {}", try!(commit_summarize(&repo, new_base_id)));
490 }
491
492 Ok(())
493}
494
495fn detach(repo: &Repository) -> Result<()> {
496 match repo.find_reference(SHEAD_REF) {
497 Ok(mut r) => try!(r.delete()),
498 Err(_) => { return Err("No current patch series to detach from.".into()); }
499 }
500 Ok(())
501}
502
503fn delete(repo: &Repository, m: &ArgMatches) -> Result<()> {
504 let name = m.value_of("name").unwrap();
505 if let Ok(shead) = repo.find_reference(SHEAD_REF) {
506 let shead_target = try!(shead_series_name(&shead));
507 if shead_target == name {
508 return Err(format!("Cannot delete the current series \"{}\"; detach first.", name).into());
509 }
510 }
511 let prefixed_name = &[SERIES_PREFIX, name].concat();
512 let deleted_ref = if let Some(mut r) = try!(notfound_to_none(repo.find_reference(prefixed_name))) {
513 try!(r.delete());
514 true
515 } else {
516 false
517 };
518 let deleted_internals = try!(Internals::delete(repo, name));
519 if !deleted_ref && !deleted_internals {
520 return Err(format!("Nothing to delete: series \"{}\" does not exist.", name).into());
521 }
522 Ok(())
523}
524
525fn get_editor(config: &Config) -> Result<OsString> {
526 if let Some(e) = env::var_os("GIT_EDITOR") {
527 return Ok(e);
528 }
529 if let Ok(e) = config.get_path("core.editor") {
530 return Ok(e.into());
531 }
532 let terminal_is_dumb = match env::var_os("TERM") {
533 None => true,
534 Some(t) => t.as_os_str() == "dumb",
535 };
536 if !terminal_is_dumb {
537 if let Some(e) = env::var_os("VISUAL") {
538 return Ok(e);
539 }
540 }
541 if let Some(e) = env::var_os("EDITOR") {
542 return Ok(e);
543 }
544 if terminal_is_dumb {
545 return Err("TERM unset or \"dumb\" but EDITOR unset".into());
546 }
547 return Ok("vi".into());
548}
549
550// Get the pager to use; with for_cmd set, get the pager for use by the
551// specified git command. If get_pager returns None, don't use a pager.
552fn get_pager(config: &Config, for_cmd: &str, default: bool) -> Option<OsString> {
553 if !isatty::stdout_isatty() {
554 return None;
555 }
556 // pager.cmd can contain a boolean (if false, force no pager) or a
557 // command-specific pager; only treat it as a command if it doesn't parse
558 // as a boolean.
559 let maybe_pager = config.get_path(&format!("pager.{}", for_cmd)).ok();
560 let (cmd_want_pager, cmd_pager) = maybe_pager.map_or((default, None), |p|
561 if let Ok(b) = Config::parse_bool(&p) {
562 (b, None)
563 } else {
564 (true, Some(p))
565 }
566 );
567 if !cmd_want_pager {
568 return None;
569 }
570 let pager =
571 if let Some(e) = env::var_os("GIT_PAGER") {
572 Some(e)
573 } else if let Some(p) = cmd_pager {
574 Some(p.into())
575 } else if let Ok(e) = config.get_path("core.pager") {
576 Some(e.into())
577 } else if let Some(e) = env::var_os("PAGER") {
578 Some(e)
579 } else {
580 Some("less".into())
581 };
582 pager.and_then(|p| if p.is_empty() || p == OsString::from("cat") { None } else { Some(p) })
583}
584
585/// Construct a Command, using the shell if the command contains shell metachars
586fn cmd_maybe_shell<S: AsRef<OsStr>>(program: S, args: bool) -> Command {
587 if program.as_ref().to_string_lossy().contains(|c| SHELL_METACHARS.contains(c)) {
588 let mut cmd = Command::new("sh");
589 cmd.arg("-c");
590 if args {
591 let mut program_with_args = program.as_ref().to_os_string();
592 program_with_args.push(" \"$@\"");
593 cmd.arg(program_with_args).arg(program);
594 } else {
595 cmd.arg(program);
596 }
597 cmd
598 } else {
599 Command::new(program)
600 }
601}
602
603fn run_editor<S: AsRef<OsStr>>(config: &Config, filename: S) -> Result<()> {
604 let editor = try!(get_editor(&config));
605 let editor_status = try!(cmd_maybe_shell(editor, true).arg(&filename).status());
606 if !editor_status.success() {
607 return Err(format!("Editor exited with status {}", editor_status).into());
608 }
609 Ok(())
610}
611
612struct Output {
613 pager: Option<std::process::Child>,
614 include_stderr: bool,
615}
616
617impl Output {
618 fn new() -> Self {
619 Output { pager: None, include_stderr: false }
620 }
621
622 fn auto_pager(&mut self, config: &Config, for_cmd: &str, default: bool) -> Result<()> {
623 if let Some(pager) = get_pager(config, for_cmd, default) {
624 let mut cmd = cmd_maybe_shell(pager, false);
625 cmd.stdin(std::process::Stdio::piped());
626 if env::var_os("LESS").is_none() {
627 cmd.env("LESS", "FRX");
628 }
629 if env::var_os("LV").is_none() {
630 cmd.env("LV", "-c");
631 }
632 let child = try!(cmd.spawn());
633 self.pager = Some(child);
634 self.include_stderr = isatty::stderr_isatty();
635 }
636 Ok(())
637 }
638
639 // Get a color to write text with, taking git configuration into account.
640 //
641 // config: the configuration to determine the color from.
642 // command: the git command to act like.
643 // slot: the color "slot" of that git command to act like.
644 // default: the color to use if not configured.
645 fn get_color(&self, config: &Config, command: &str, slot: &str, default: &str) -> Result<Style> {
646 if !cfg!(unix) {
647 return Ok(Style::new());
648 }
649 let color_ui = try!(notfound_to_none(config.get_str("color.ui"))).unwrap_or("auto");
650 let color_cmd = try!(notfound_to_none(config.get_str(&format!("color.{}", command)))).unwrap_or(color_ui);
651 if color_cmd == "never" || Config::parse_bool(color_cmd) == Ok(false) {
652 return Ok(Style::new());
653 }
654 if self.pager.is_some() {
655 let color_pager = try!(notfound_to_none(config.get_bool(&format!("color.pager")))).unwrap_or(true);
656 if !color_pager {
657 return Ok(Style::new());
658 }
659 } else if !isatty::stdout_isatty() {
660 return Ok(Style::new());
661 }
662 let cfg = format!("color.{}.{}", command, slot);
663 let color = try!(notfound_to_none(config.get_str(&cfg))).unwrap_or(default);
664 colorparse::parse(color).map_err(|e| format!("Error parsing {}: {}", cfg, e).into())
665 }
666
667 fn write_err(&mut self, msg: &str) {
668 if self.include_stderr {
669 if write!(self, "{}", msg).is_err() {
670 write!(std::io::stderr(), "{}", msg).unwrap();
671 }
672 } else {
673 write!(std::io::stderr(), "{}", msg).unwrap();
674 }
675 }
676}
677
678impl Drop for Output {
679 fn drop(&mut self) {
680 if let Some(ref mut child) = self.pager {
681 let status = child.wait().unwrap();
682 if !status.success() {
683 writeln!(std::io::stderr(), "Pager exited with status {}", status).unwrap();
684 }
685 }
686 }
687}
688
689impl IoWrite for Output {
690 fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
691 match self.pager {
692 Some(ref mut child) => child.stdin.as_mut().unwrap().write(buf),
693 None => std::io::stdout().write(buf),
694 }
695 }
696
697 fn flush(&mut self) -> std::io::Result<()> {
698 match self.pager {
699 Some(ref mut child) => child.stdin.as_mut().unwrap().flush(),
700 None => std::io::stdout().flush(),
701 }
702 }
703}
704
705fn get_signature(config: &Config, which: &str) -> Result<git2::Signature<'static>> {
706 let name_var = ["GIT_", which, "_NAME"].concat();
707 let email_var = ["GIT_", which, "_EMAIL"].concat();
708 let which_lc = which.to_lowercase();
709 let name = try!(env::var(&name_var).or_else(
710 |_| config.get_string("user.name").or_else(
711 |_| Err(format!("Could not determine {} name: checked ${} and user.name in git config", which_lc, name_var)))));
712 let email = try!(env::var(&email_var).or_else(
713 |_| config.get_string("user.email").or_else(
714 |_| env::var("EMAIL").or_else(
715 |_| Err(format!("Could not determine {} email: checked ${}, user.email in git config, and $EMAIL", which_lc, email_var))))));
716 Ok(try!(git2::Signature::now(&name, &email)))
717}
718
719fn commit_status(out: &mut Output, repo: &Repository, m: &ArgMatches, do_status: bool) -> Result<()> {
720 let config = try!(try!(repo.config()).snapshot());
721 let shead = match repo.find_reference(SHEAD_REF) {
722 Err(ref e) if e.code() == git2::ErrorCode::NotFound => { println!("No series; use \"git series start <name>\" to start"); return Ok(()); }
723 result => try!(result),
724 };
725 let series_name = try!(shead_series_name(&shead));
726
727 if do_status {
728 try!(out.auto_pager(&config, "status", false));
729 }
730 let get_color = |out: &Output, color: &str, default: &str| {
731 if do_status {
732 out.get_color(&config, "status", color, default)
733 } else {
734 Ok(Style::new())
735 }
736 };
737 let color_normal = Style::new();
738 let color_header = try!(get_color(out, "header", "normal"));
739 let color_updated = try!(get_color(out, "updated", "green"));
740 let color_changed = try!(get_color(out, "changed", "red"));
741
742 let write_status = |status: &mut Vec<ansi_term::ANSIString>, diff: &Diff, heading: &str, color: &Style, show_hints: bool, hints: &[&str]| -> Result<bool> {
743 let mut changes = false;
744
745 try!(diff.foreach(&mut |delta, _| {
746 if !changes {
747 changes = true;
748 status.push(color_header.paint(format!("{}\n", heading.to_string())));
749 if show_hints {
750 for hint in hints {
751 status.push(color_header.paint(format!(" ({})\n", hint)));
752 }
753 }
754 status.push(color_normal.paint("\n"));
755 }
756 status.push(color_normal.paint(" "));
757 status.push(color.paint(format!("{:?}: {}\n", delta.status(), delta.old_file().path().unwrap().to_str().unwrap())));
758 true
759 }, None, None, None));
760
761 if changes {
762 status.push(color_normal.paint("\n"));
763 }
764
765 Ok(changes)
766 };
767
768 let mut status = Vec::new();
769 status.push(color_header.paint(format!("On series {}\n", series_name)));
770
771 let mut internals = try!(Internals::read(repo));
772 let working_tree = try!(repo.find_tree(try!(internals.working.write())));
773 let staged_tree = try!(repo.find_tree(try!(internals.staged.write())));
774
775 let shead_commit = match shead.resolve() {
776 Ok(r) => Some(try!(peel_to_commit(r))),
777 Err(ref e) if e.code() == git2::ErrorCode::NotFound => {
778 status.push(color_header.paint("\nInitial series commit\n"));
779 None
780 }
781 Err(e) => try!(Err(e)),
782 };
783 let shead_tree = match shead_commit {
784 Some(ref c) => Some(try!(c.tree())),
785 None => None,
786 };
787
788 let commit_all = m.is_present("all");
789
790 let (changes, tree, diff) = if commit_all {
791 let diff = try!(repo.diff_tree_to_tree(shead_tree.as_ref(), Some(&working_tree), None));
792 let changes = try!(write_status(&mut status, &diff, "Changes to be committed:", &color_normal, false, &[]));
793 if !changes {
794 status.push(color_normal.paint("nothing to commit; series unchanged\n"));
795 }
796 (changes, working_tree, diff)
797 } else {
798 let diff = try!(repo.diff_tree_to_tree(shead_tree.as_ref(), Some(&staged_tree), None));
799 let changes_to_be_committed = try!(write_status(&mut status, &diff,
800 "Changes to be committed:", &color_updated, do_status,
801 &["use \"git series commit\" to commit",
802 "use \"git series unadd <file>...\" to undo add"]));
803
804 let diff_not_staged = try!(repo.diff_tree_to_tree(Some(&staged_tree), Some(&working_tree), None));
805 let changes_not_staged = try!(write_status(&mut status, &diff_not_staged,
806 "Changes not staged for commit:", &color_changed, do_status,
807 &["use \"git series add <file>...\" to update what will be committed"]));
808
809 if !changes_to_be_committed {
810 if changes_not_staged {
811 status.push(color_normal.paint("no changes added to commit (use \"git series add\" or \"git series commit -a\")\n"));
812 } else {
813 status.push(color_normal.paint("nothing to commit; series unchanged\n"));
814 }
815 }
816
817 (changes_to_be_committed, staged_tree, diff)
818 };
819
820 let status = ansi_term::ANSIStrings(&status).to_string();
821 if do_status || !changes {
822 if do_status {
823 try!(write!(out, "{}", status));
824 } else {
825 return Err(status.into());
826 }
827 return Ok(());
828 }
829
830 // Check that the commit includes the series
831 let series_id = match tree.get_name("series") {
832 None => { return Err(concat!("Cannot commit: initial commit must include \"series\"\n",
833 "Use \"git series add series\" or \"git series commit -a\"").into()); }
834 Some(series) => series.id()
835 };
836
837 // Check that the base is still an ancestor of the series
838 if let Some(base) = tree.get_name("base") {
839 if base.id() != series_id && !try!(repo.graph_descendant_of(series_id, base.id())) {
840 let (base_short_id, base_summary) = try!(commit_summarize_components(&repo, base.id()));
841 let (series_short_id, series_summary) = try!(commit_summarize_components(&repo, series_id));
842 return Err(format!(concat!(
843 "Cannot commit: base {} is not an ancestor of patch series {}\n",
844 "base {} {}\n",
845 "series {} {}"),
846 base_short_id, series_short_id,
847 base_short_id, base_summary,
848 series_short_id, series_summary).into());
849 }
850 }
851
852 let msg = match m.value_of("m") {
853 Some(s) => s.to_string(),
854 None => {
855 let filename = repo.path().join("SCOMMIT_EDITMSG");
856 let mut file = try!(File::create(&filename));
857 try!(write!(file, "{}", COMMIT_MESSAGE_COMMENT));
858 for line in status.lines() {
859 if line.is_empty() {
860 try!(writeln!(file, "#"));
861 } else {
862 try!(writeln!(file, "# {}", line));
863 }
864 }
865 if m.is_present("verbose") {
866 try!(writeln!(file, "{}\n{}", SCISSOR_LINE, SCISSOR_COMMENT));
867 try!(write_diff(&mut file, &diff));
868 }
869 drop(file);
870 try!(run_editor(&config, &filename));
871 let mut file = try!(File::open(&filename));
872 let mut msg = String::new();
873 try!(file.read_to_string(&mut msg));
874 if let Some(scissor_index) = msg.find(SCISSOR_LINE) {
875 msg.truncate(scissor_index);
876 }
877 try!(git2::message_prettify(msg, git2::DEFAULT_COMMENT_CHAR))
878 }
879 };
880 if msg.is_empty() {
881 return Err("Aborting series commit due to empty commit message.".into());
882 }
883
884 let author = try!(get_signature(&config, "AUTHOR"));
885 let committer = try!(get_signature(&config, "COMMITTER"));
886 let mut parents: Vec<Oid> = Vec::new();
887 // Include all commits from tree, to keep them reachable and fetchable.
888 for e in tree.iter() {
889 if e.kind() == Some(ObjectType::Commit) && e.name().unwrap() != "base" {
890 parents.push(e.id())
891 }
892 }
893 let parents = try!(parents_from_ids(repo, parents));
894 let parents_ref: Vec<&_> = shead_commit.iter().chain(parents.iter()).collect();
895 let new_commit_oid = try!(repo.commit(Some(SHEAD_REF), &author, &committer, &msg, &tree, &parents_ref));
896
897 if commit_all {
898 internals.staged = try!(repo.treebuilder(Some(&tree)));
899 try!(internals.write(repo));
900 }
901
902 let (new_commit_short_id, new_commit_summary) = try!(commit_summarize_components(&repo, new_commit_oid));
903 try!(writeln!(out, "[{} {}] {}", series_name, new_commit_short_id, new_commit_summary));
904
905 Ok(())
906}
907
908fn cover(repo: &Repository, m: &ArgMatches) -> Result<()> {
909 let mut internals = try!(Internals::read(repo));
910
911 let (working_cover_id, working_cover_content) = match try!(internals.working.get("cover")) {
912 None => (zero_oid(), String::new()),
913 Some(entry) => (entry.id(), try!(std::str::from_utf8(try!(repo.find_blob(entry.id())).content())).to_string()),
914 };
915
916 if m.is_present("delete") {
917 if working_cover_id.is_zero() {
918 return Err("No cover to delete".into());
919 }
920 try!(internals.working.remove("cover"));
921 try!(internals.write(repo));
922 println!("Deleted cover letter");
923 return Ok(());
924 }
925
926 let filename = repo.path().join("COVER_EDITMSG");
927 let mut file = try!(File::create(&filename));
928 if working_cover_content.is_empty() {
929 try!(write!(file, "{}", COVER_LETTER_COMMENT));
930 } else {
931 try!(write!(file, "{}", working_cover_content));
932 }
933 drop(file);
934 let config = try!(repo.config());
935 try!(run_editor(&config, &filename));
936 let mut file = try!(File::open(&filename));
937 let mut msg = String::new();
938 try!(file.read_to_string(&mut msg));
939 let msg = try!(git2::message_prettify(msg, git2::DEFAULT_COMMENT_CHAR));
940 if msg.is_empty() {
941 return Err("Empty cover letter; not changing.\n(To delete the cover letter, use \"git series -d\".)".into());
942 }
943
944 let new_cover_id = try!(repo.blob(msg.as_bytes()));
945 if new_cover_id == working_cover_id {
946 println!("Cover letter unchanged");
947 } else {
948 try!(internals.working.insert("cover", new_cover_id, GIT_FILEMODE_BLOB as i32));
949 try!(internals.write(repo));
950 println!("Updated cover letter");
951 }
952
953 Ok(())
954}
955
956fn date_822(t: git2::Time) -> String {
957 let offset = chrono::offset::fixed::FixedOffset::east(t.offset_minutes()*60);
958 let datetime = offset.timestamp(t.seconds(), 0);
959 datetime.to_rfc2822()
960}
961
962fn shortlog(commits: &mut [Commit]) -> String {
963 let mut s = String::new();
964 let mut author_map = std::collections::HashMap::new();
965
966 for mut commit in commits {
967 let author = commit.author().name().unwrap().to_string();
968 author_map.entry(author).or_insert(Vec::new()).push(commit.summary().unwrap().to_string());
969 }
970
971 let mut authors: Vec<_> = author_map.keys().collect();
972 authors.sort();
973 let mut first = true;
974 for author in authors {
975 if first {
976 first = false;
977 } else {
978 writeln!(s, "").unwrap();
979 }
980 let summaries = author_map.get(author).unwrap();
981 writeln!(s, "{} ({}):", author, summaries.len()).unwrap();
982 for summary in summaries {
983 writeln!(s, " {}", summary).unwrap();
984 }
985 }
986
987 s
988}
989
990fn ascii_isalnum(c: char) -> bool {
991 (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9')
992}
993
994fn sanitize_summary(summary: &str) -> String {
995 let mut s = String::with_capacity(summary.len());
996 let mut prev_dot = false;
997 let mut need_space = false;
998 for c in summary.chars() {
999 if ascii_isalnum(c) || c == '_' || c == '.' {
1000 if need_space {
1001 s.push('-');
1002 need_space = false;
1003 }
1004 if !(prev_dot && c == '.') {
1005 s.push(c);
1006 }
1007 } else {
1008 if !s.is_empty() {
1009 need_space = true;
1010 }
1011 }
1012 prev_dot = c == '.';
1013 }
1014 let end = s.trim_right_matches(|c| c == '.' || c == '-').len();
1015 s.truncate(end);
1016 s
1017}
1018
1019#[test]
1020fn test_sanitize_summary() {
1021 let tests = vec![
1022 ("", ""),
1023 ("!!!!!", ""),
1024 ("Test", "Test"),
1025 ("Test case", "Test-case"),
1026 ("Test case", "Test-case"),
1027 (" Test case ", "Test-case"),
1028 ("...Test...case...", ".Test.case"),
1029 ("...Test...case.!!", ".Test.case"),
1030 (".!.Test.!.case.!.", ".-.Test.-.case"),
1031 ];
1032 for (summary, sanitized) in tests {
1033 assert_eq!(sanitize_summary(summary), sanitized.to_string());
1034 }
1035}
1036
1037fn split_message(message: &str) -> (&str, &str) {
1038 let mut iter = message.splitn(2, '\n');
1039 let subject = iter.next().unwrap().trim_right();
1040 let body = iter.next().map(|s| s.trim_left()).unwrap_or("");
1041 (subject, body)
1042}
1043
1044fn diffstat(diff: &Diff) -> Result<String> {
1045 let stats = try!(diff.stats());
1046 let stats_buf = try!(stats.to_buf(git2::DIFF_STATS_FULL|git2::DIFF_STATS_INCLUDE_SUMMARY, 72));
1047 Ok(stats_buf.as_str().unwrap().to_string())
1048}
1049
1050fn write_diff<W: IoWrite>(f: &mut W, diff: &Diff) -> Result<()> {
1051 let mut err = Ok(());
1052 try!(diff.print(git2::DiffFormat::Patch, |_, _, l| {
1053 err = || -> Result<()> {
1054 let o = l.origin();
1055 if o == '+' || o == '-' || o == ' ' {
1056 try!(f.write_all(&[o as u8]));
1057 }
1058 try!(f.write_all(l.content()));
1059 Ok(())
1060 }();
1061 err.is_ok()
1062 }));
1063 err
1064}
1065
1066fn mail_signature() -> String {
1067 format!("-- \ngit-series {}", crate_version!())
1068}
1069
1070fn ensure_nl(s: &str) -> &'static str {
1071 if !s.ends_with('\n') {
1072 "\n"
1073 } else {
1074 ""
1075 }
1076}
1077
1078fn format(out: &mut Output, repo: &Repository, m: &ArgMatches) -> Result<()> {
1079 let config = try!(repo.config());
1080 let to_stdout = m.is_present("stdout");
1081 let no_from = m.is_present("no-from");
1082
1083 let shead_commit = try!(peel_to_commit(try!(try!(repo.find_reference(SHEAD_REF)).resolve())));
1084 let stree = try!(shead_commit.tree());
1085
1086 let series = try!(stree.get_name("series").ok_or("Internal error: series did not contain \"series\""));
1087 let base = try!(stree.get_name("base").ok_or("Cannot format series; no base set.\nUse \"git series base\" to set base."));
1088
1089 let mut revwalk = try!(repo.revwalk());
1090 revwalk.set_sorting(git2::SORT_TOPOLOGICAL|git2::SORT_REVERSE);
1091 try!(revwalk.push(series.id()));
1092 try!(revwalk.hide(base.id()));
1093 let mut commits: Vec<Commit> = try!(revwalk.map(|c| {
1094 let id = try!(c);
1095 let commit = try!(repo.find_commit(id));
1096 if commit.parent_ids().count() > 1 {
1097 return Err(format!("Error: cannot format merge commit as patch:\n{}", try!(commit_summarize(repo, id))).into());
1098 }
1099 Ok(commit)
1100 }).collect::<Result<_>>());
1101 if commits.is_empty() {
1102 return Err("No patches to format; series and base identical.".into());
1103 }
1104
1105 let committer = try!(get_signature(&config, "COMMITTER"));
1106 let committer_name = committer.name().unwrap();
1107 let committer_email = committer.email().unwrap();
1108 let message_id_suffix = format!("{}.git-series.{}", committer.when().seconds(), committer_email);
1109
1110 let cover_entry = stree.get_name("cover");
1111 let mut in_reply_to_message_id = m.value_of("in-reply-to").map(|v| {
1112 format!("{}{}{}",
1113 if v.starts_with('<') { "" } else { "<" },
1114 v,
1115 if v.ends_with('>') { "" } else { ">" })
1116 });
1117
1118 let version = m.value_of("reroll-count");
1119 let subject_patch = version.map_or("PATCH".to_string(), |n| format!("PATCH v{}", n));
1120 let file_prefix = version.map_or("".to_string(), |n| format!("v{}-", n));
1121
1122 let signature = mail_signature();
1123
1124 let mut out : Box<IoWrite> = if to_stdout {
1125 try!(out.auto_pager(&config, "format-patch", true));
1126 Box::new(out)
1127 } else {
1128 Box::new(std::io::stdout())
1129 };
1130 let patch_file = |name: &str| -> Result<Box<IoWrite>> {
1131 let name = format!("{}{}", file_prefix, name);
1132 println!("{}", name);
1133 Ok(Box::new(try!(File::create(name))))
1134 };
1135
1136 if let Some(ref entry) = cover_entry {
1137 let cover_blob = try!(repo.find_blob(entry.id()));
1138 let content = try!(std::str::from_utf8(cover_blob.content())).to_string();
1139 let (subject, body) = split_message(&content);
1140
1141 let series_tree = try!(repo.find_commit(series.id())).tree().unwrap();
1142 let base_tree = try!(repo.find_commit(base.id())).tree().unwrap();
1143 let diff = try!(repo.diff_tree_to_tree(Some(&base_tree), Some(&series_tree), None));
1144 let stats = try!(diffstat(&diff));
1145
1146 if !to_stdout {
1147 out = try!(patch_file("0000-cover-letter.patch"));
1148 }
1149 try!(writeln!(out, "From {} Mon Sep 17 00:00:00 2001", shead_commit.id()));
1150 let cover_message_id = format!("<cover.{}.{}>", shead_commit.id(), message_id_suffix);
1151 try!(writeln!(out, "Message-Id: {}", cover_message_id));
1152 if let Some(ref message_id) = in_reply_to_message_id {
1153 try!(writeln!(out, "In-Reply-To: {}", message_id));
1154 try!(writeln!(out, "References: {}", message_id));
1155 }
1156 in_reply_to_message_id = Some(cover_message_id);
1157 try!(writeln!(out, "From: {} <{}>", committer_name, committer_email));
1158 try!(writeln!(out, "Date: {}", date_822(committer.when())));
1159 try!(writeln!(out, "Subject: [{} 0/{}] {}\n", subject_patch, commits.len(), subject));
1160 if !body.is_empty() {
1161 try!(writeln!(out, "{}", body));
1162 }
1163 try!(writeln!(out, "{}", shortlog(&mut commits)));
1164 try!(writeln!(out, "{}", stats));
1165 try!(writeln!(out, "{}", signature));
1166 }
1167
1168 for (commit_num, commit) in commits.iter().enumerate() {
1169 if to_stdout && (commit_num > 0 || cover_entry.is_some()) {
1170 try!(writeln!(out, ""));
1171 }
1172
1173 let message = commit.message().unwrap();
1174 let (subject, body) = split_message(message);
1175 let commit_id = commit.id();
1176 let commit_author = commit.author();
1177 let commit_author_name = commit_author.name().unwrap();
1178 let commit_author_email = commit_author.email().unwrap();
1179 let summary_sanitized = sanitize_summary(&subject);
1180 let this_message_id = format!("<{}.{}>", commit_id, message_id_suffix);
1181 let parent = try!(commit.parent(0));
1182 let diff = try!(repo.diff_tree_to_tree(Some(&parent.tree().unwrap()), Some(&commit.tree().unwrap()), None));
1183 let stats = try!(diffstat(&diff));
1184
1185 if !to_stdout {
1186 out = try!(patch_file(&format!("{:04}-{}.patch", commit_num+1, summary_sanitized)));
1187 }
1188 try!(writeln!(out, "From {} Mon Sep 17 00:00:00 2001", commit_id));
1189 try!(writeln!(out, "Message-Id: {}", this_message_id));
1190 if let Some(ref message_id) = in_reply_to_message_id {
1191 try!(writeln!(out, "In-Reply-To: {}", message_id));
1192 try!(writeln!(out, "References: {}", message_id));
1193 }
1194 if commit_num == 0 && cover_entry.is_none() {
1195 in_reply_to_message_id = Some(this_message_id);
1196 }
1197 if no_from {
1198 try!(writeln!(out, "From: {} <{}>", commit_author_name, commit_author_email));
1199 } else {
1200 try!(writeln!(out, "From: {} <{}>", committer_name, committer_email));
1201 }
1202 try!(writeln!(out, "Date: {}", date_822(commit_author.when())));
1203 try!(writeln!(out, "Subject: [{} {}/{}] {}\n", subject_patch, commit_num+1, commits.len(), subject));
1204
1205 if !no_from && (commit_author_name != committer_name || commit_author_email != committer_email) {
1206 try!(writeln!(out, "From: {} <{}>\n", commit_author_name, commit_author_email));
1207 }
1208 if !body.is_empty() {
1209 try!(write!(out, "{}{}", body, ensure_nl(&body)));
1210 }
1211 try!(writeln!(out, "---"));
1212 try!(writeln!(out, "{}", stats));
1213 try!(write_diff(&mut out, &diff));
1214 try!(writeln!(out, "{}", signature));
1215 }
1216
1217 Ok(())
1218}
1219
1220fn log(out: &mut Output, repo: &Repository, m: &ArgMatches) -> Result<()> {
1221 let config = try!(try!(repo.config()).snapshot());
1222 try!(out.auto_pager(&config, "log", true));
1223 let color_commit = try!(out.get_color(&config, "diff", "commit", "yellow"));
1224
1225 let mut revwalk = try!(repo.revwalk());
1226 try!(revwalk.push_ref(SHEAD_REF));
1227
1228 // Walk once before sorting, to find all the commits to hide. Revwalk doesn't support hiding on
1229 // the fly when sorted.
1230 let mut hidden_ids = std::collections::HashSet::new();
1231 while let Some(oid) = revwalk.next() {
1232 let oid = try!(oid);
1233 let commit = try!(repo.find_commit(oid));
1234 let tree = try!(commit.tree());
1235 for parent_id in commit.parent_ids() {
1236 if tree.get_id(parent_id).is_some() {
1237 try!(revwalk.hide(parent_id));
1238 hidden_ids.insert(parent_id);
1239 }
1240 }
1241 }
1242
1243 // set_sorting resets the revwalk
1244 revwalk.set_sorting(git2::SORT_TOPOLOGICAL);
1245 try!(revwalk.push_ref(SHEAD_REF));
1246 for id in hidden_ids {
1247 try!(revwalk.hide(id));
1248 }
1249
1250 let show_diff = m.is_present("patch");
1251
1252 let mut first = true;
1253 for oid in revwalk {
1254 if first {
1255 first = false;
1256 } else {
1257 try!(writeln!(out, ""));
1258 }
1259 let oid = try!(oid);
1260 let commit = try!(repo.find_commit(oid));
1261 let author = commit.author();
1262
1263 try!(writeln!(out, "{}", color_commit.paint(format!("commit {}", oid))));
1264 try!(writeln!(out, "Author: {} <{}>", author.name().unwrap(), author.email().unwrap()));
1265 try!(writeln!(out, "Date: {}\n", date_822(author.when())));
1266 for line in commit.message().unwrap().lines() {
1267 try!(writeln!(out, " {}", line));
1268 }
1269
1270 if show_diff {
1271 let tree = try!(commit.tree());
1272 let parent_ids: Vec<_> = commit.parent_ids().take_while(|parent_id| tree.get_id(*parent_id).is_none()).collect();
1273
1274 try!(writeln!(out, ""));
1275 if parent_ids.len() > 1 {
1276 try!(writeln!(out, "(Diffs of series merge commits not yet supported)"));
1277 } else {
1278 let parent_tree = if parent_ids.len() == 0 {
1279 None
1280 } else {
1281 Some(try!(try!(repo.find_commit(parent_ids[0])).tree()))
1282 };
1283 let diff = try!(repo.diff_tree_to_tree(parent_tree.as_ref(), Some(&tree), None));
1284 try!(write_diff(out, &diff));
1285 }
1286 }
1287 }
1288
1289 Ok(())
1290}
1291
1292fn rebase(repo: &Repository, m: &ArgMatches) -> Result<()> {
1293 match repo.state() {
1294 git2::RepositoryState::Clean => (),
1295 git2::RepositoryState::RebaseMerge if repo.path().join("rebase-merge").join("git-series").exists() => {
1296 return Err("git series rebase already in progress.\nUse \"git rebase --continue\" or \"git rebase --abort\".".into());
1297 },
1298 s => { return Err(format!("{:?} in progress; cannot rebase", s).into()); }
1299 }
1300
1301 let internals = try!(Internals::read(repo));
1302 let series = try!(try!(internals.working.get("series")).ok_or("Could not find entry \"series\" in working index"));
1303 let base = try!(try!(internals.working.get("base")).ok_or("Cannot rebase series; no base set.\nUse \"git series base\" to set base."));
1304 if series.id() == base.id() {
1305 return Err("No patches to rebase; series and base identical.".into());
1306 } else if !try!(repo.graph_descendant_of(series.id(), base.id())) {
1307 return Err(format!("Cannot rebase: current base {} not an ancestor of series {}", base.id(), series.id()).into());
1308 }
1309
1310 // Check for unstaged or uncommitted changes before attempting to rebase.
1311 let series_commit = try!(repo.find_commit(series.id()));
1312 let series_tree = try!(series_commit.tree());
1313 let mut unclean = String::new();
1314 if !diff_empty(&try!(repo.diff_tree_to_index(Some(&series_tree), None, None))) {
1315 writeln!(unclean, "Cannot rebase: you have unstaged changes.").unwrap();
1316 }
1317 if !diff_empty(&try!(repo.diff_index_to_workdir(None, None))) {
1318 if unclean.is_empty() {
1319 writeln!(unclean, "Cannot rebase: your index contains uncommitted changes.").unwrap();
1320 } else {
1321 writeln!(unclean, "Additionally, your index contains uncommitted changes.").unwrap();
1322 }
1323 }
1324 if !unclean.is_empty() {
1325 return Err(unclean.into());
1326 }
1327
1328 let mut revwalk = try!(repo.revwalk());
1329 revwalk.set_sorting(git2::SORT_TOPOLOGICAL|git2::SORT_REVERSE);
1330 try!(revwalk.push(series.id()));
1331 try!(revwalk.hide(base.id()));
1332 let commits: Vec<Commit> = try!(revwalk.map(|c| {
1333 let id = try!(c);
1334 let mut commit = try!(repo.find_commit(id));
1335 if commit.parent_ids().count() > 1 {
1336 return Err(format!("Error: cannot rebase merge commit:\n{}", try!(commit_obj_summarize(&mut commit))).into());
1337 }
1338 Ok(commit)
1339 }).collect::<Result<_>>());
1340
1341 let interactive = m.is_present("interactive");
1342 let onto = match m.value_of("onto") {
1343 None => None,
1344 Some(onto) => {
1345 let obj = try!(repo.revparse_single(onto));
1346 Some(obj.id())
1347 },
1348 };
1349
1350 let newbase = onto.unwrap_or(base.id());
1351 let (base_short, _) = try!(commit_summarize_components(&repo, base.id()));
1352 let (newbase_short, _) = try!(commit_summarize_components(&repo, newbase));
1353 let (series_short, _) = try!(commit_summarize_components(&repo, series.id()));
1354
1355 let newbase_obj = try!(repo.find_commit(newbase)).into_object();
1356
1357 let dir = try!(TempDir::new_in(repo.path(), "rebase-merge"));
1358 let final_path = repo.path().join("rebase-merge");
1359 let mut create = std::fs::OpenOptions::new();
1360 create.write(true).create_new(true);
1361
1362 try!(create.open(dir.path().join("git-series")));
1363 try!(create.open(dir.path().join("quiet")));
1364 try!(create.open(dir.path().join("interactive")));
1365
1366 let mut head_name_file = try!(create.open(dir.path().join("head-name")));
1367 try!(writeln!(head_name_file, "detached HEAD"));
1368
1369 let mut onto_file = try!(create.open(dir.path().join("onto")));
1370 try!(writeln!(onto_file, "{}", newbase));
1371
1372 let mut orig_head_file = try!(create.open(dir.path().join("orig-head")));
1373 try!(writeln!(orig_head_file, "{}", series.id()));
1374
1375 let git_rebase_todo_filename = dir.path().join("git-rebase-todo");
1376 let mut git_rebase_todo = try!(create.open(&git_rebase_todo_filename));
1377 for mut commit in commits {
1378 try!(writeln!(git_rebase_todo, "pick {}", try!(commit_obj_summarize(&mut commit))));
1379 }
1380 if let Some(onto) = onto {
1381 try!(writeln!(git_rebase_todo, "exec git series base {}", onto));
1382 }
1383 try!(writeln!(git_rebase_todo, "\n# Rebase {}..{} onto {}", base_short, series_short, newbase_short));
1384 try!(write!(git_rebase_todo, "{}", REBASE_COMMENT));
1385 drop(git_rebase_todo);
1386
1387 // Interactive editor if interactive {
1388 if interactive {
1389 let config = try!(repo.config());
1390 try!(run_editor(&config, &git_rebase_todo_filename));
1391 let mut file = try!(File::open(&git_rebase_todo_filename));
1392 let mut todo = String::new();
1393 try!(file.read_to_string(&mut todo));
1394 let todo = try!(git2::message_prettify(todo, git2::DEFAULT_COMMENT_CHAR));
1395 if todo.is_empty() {
1396 return Err("Nothing to do".into());
1397 }
1398 }
1399
1400 // Avoid races by not calling .into_path until after the rename succeeds.
1401 try!(std::fs::rename(dir.path(), final_path));
1402 dir.into_path();
1403
1404 try!(checkout_tree(repo, &newbase_obj));
1405 try!(repo.reference("HEAD", newbase, true, &format!("rebase -i (start): checkout {}", newbase)));
1406
1407 let status = try!(Command::new("git").arg("rebase").arg("--continue").status());
1408 if !status.success() {
1409 return Err(format!("git rebase --continue exited with status {}", status).into());
1410 }
1411
1412 Ok(())
1413}
1414
1415fn req(out: &mut Output, repo: &Repository, m: &ArgMatches) -> Result<()> {
1416 let config = try!(repo.config());
1417 let shead = try!(repo.find_reference(SHEAD_REF));
1418 let shead_commit = try!(peel_to_commit(try!(shead.resolve())));
1419 let stree = try!(shead_commit.tree());
1420
1421 let series = try!(stree.get_name("series").ok_or("Internal error: series did not contain \"series\""));
1422 let series_id = series.id();
1423 let mut series_commit = try!(repo.find_commit(series_id));
1424 let base = try!(stree.get_name("base").ok_or("Cannot request pull; no base set.\nUse \"git series base\" to set base."));
1425 let mut base_commit = try!(repo.find_commit(base.id()));
1426
1427 let (cover_content, subject, cover_body) = if let Some(entry) = stree.get_name("cover") {
1428 let cover_blob = try!(repo.find_blob(entry.id()));
1429 let content = try!(std::str::from_utf8(cover_blob.content())).to_string();
1430 let (subject, body) = split_message(&content);
1431 (Some(content.to_string()), subject.to_string(), Some(body.to_string()))
1432 } else {
1433 (None, try!(shead_series_name(&shead)), None)
1434 };
1435
1436 let url = m.value_of("url").unwrap();
1437 let tag = m.value_of("tag").unwrap();
1438 let full_tag = format!("refs/tags/{}", tag);
1439 let full_tag_peeled = format!("{}^{{}}", full_tag);
1440 let full_head = format!("refs/heads/{}", tag);
1441 let mut remote = try!(repo.remote_anonymous(url));
1442 try!(remote.connect(git2::Direction::Fetch).map_err(|e| format!("Could not connect to remote repository {}\n{}", url, e)));
1443 let remote_heads = try!(remote.list());
1444
1445 /* Find the requested name as either a tag or head */
1446 let mut opt_remote_tag = None;
1447 let mut opt_remote_tag_peeled = None;
1448 let mut opt_remote_head = None;
1449 for h in remote_heads {
1450 if h.name() == full_tag {
1451 opt_remote_tag = Some(h.oid());
1452 } else if h.name() == full_tag_peeled {
1453 opt_remote_tag_peeled = Some(h.oid());
1454 } else if h.name() == full_head {
1455 opt_remote_head = Some(h.oid());
1456 }
1457 }
1458 let (msg, extra_body, remote_pull_name) = match (opt_remote_tag, opt_remote_tag_peeled, opt_remote_head) {
1459 (Some(remote_tag), Some(remote_tag_peeled), _) => {
1460 if remote_tag_peeled != series_id {
1461 return Err(format!("Remote tag {} does not refer to series {}", tag, series_id).into());
1462 }
1463 let local_tag = try!(repo.find_tag(remote_tag).map_err(|e|
1464 format!("Could not find remote tag {} ({}) in local repository: {}", tag, remote_tag, e)));
1465 let mut local_tag_msg = local_tag.message().unwrap().to_string();
1466 if let Some(sig_index) = local_tag_msg.find("-----BEGIN PGP ") {
1467 local_tag_msg.truncate(sig_index);
1468 }
1469 let extra_body = match cover_content {
1470 Some(ref content) if !local_tag_msg.contains(content) => cover_body,
1471 _ => None,
1472 };
1473 (Some(local_tag_msg), extra_body, full_tag)
1474 },
1475 (Some(remote_tag), None, _) => {
1476 if remote_tag != series_id {
1477 return Err(format!("Remote unannotated tag {} does not refer to series {}", tag, series_id).into());
1478 }
1479 (cover_content, None, full_tag)
1480 }
1481 (_, _, Some(remote_head)) => {
1482 if remote_head != series_id {
1483 return Err(format!("Remote branch {} does not refer to series {}", tag, series_id).into());
1484 }
1485 (cover_content, None, full_head)
1486 },
1487 _ => {
1488 return Err(format!("Remote does not have either a tag or branch named {}", tag).into())
1489 }
1490 };
1491
1492 let commit_subject_date = |commit: &mut Commit| -> String {
1493 let date = date_822(commit.author().when());
1494 let summary = commit.summary().unwrap();
1495 format!(" {} ({})", summary, date)
1496 };
1497
1498 let mut revwalk = try!(repo.revwalk());
1499 revwalk.set_sorting(git2::SORT_TOPOLOGICAL|git2::SORT_REVERSE);
1500 try!(revwalk.push(series_id));
1501 try!(revwalk.hide(base.id()));
1502 let mut commits: Vec<Commit> = try!(revwalk.map(|c| {
1503 Ok(try!(repo.find_commit(try!(c))))
1504 }).collect::<Result<_>>());
1505 if commits.is_empty() {
1506 return Err("No patches to request pull of; series and base identical.".into());
1507 }
1508
1509 let author = try!(get_signature(&config, "AUTHOR"));
1510 let author_email = author.email().unwrap();
1511 let message_id = format!("<pull.{}.{}.git-series.{}>", shead_commit.id(), author.when().seconds(), author_email);
1512
1513 let diff = try!(repo.diff_tree_to_tree(Some(&base_commit.tree().unwrap()), Some(&series_commit.tree().unwrap()), None));
1514 let stats = try!(diffstat(&diff));
1515
1516 try!(out.auto_pager(&config, "request-pull", true));
1517 try!(writeln!(out, "From {} Mon Sep 17 00:00:00 2001", shead_commit.id()));
1518 try!(writeln!(out, "Message-Id: {}", message_id));
1519 try!(writeln!(out, "From: {} <{}>", author.name().unwrap(), author_email));
1520 try!(writeln!(out, "Date: {}", date_822(author.when())));
1521 try!(writeln!(out, "Subject: [GIT PULL] {}\n", subject));
1522 if let Some(extra_body) = extra_body {
1523 try!(writeln!(out, "{}", extra_body));
1524 }
1525 try!(writeln!(out, "The following changes since commit {}:\n", base.id()));
1526 try!(writeln!(out, "{}\n", commit_subject_date(&mut base_commit)));
1527 try!(writeln!(out, "are available in the git repository at:\n"));
1528 try!(writeln!(out, " {} {}\n", url, remote_pull_name));
1529 try!(writeln!(out, "for you to fetch changes up to {}:\n", series.id()));
1530 try!(writeln!(out, "{}\n", commit_subject_date(&mut series_commit)));
1531 try!(writeln!(out, "----------------------------------------------------------------"));
1532 if let Some(msg) = msg {
1533 try!(writeln!(out, "{}", msg));
1534 try!(writeln!(out, "----------------------------------------------------------------"));
1535 }
1536 try!(writeln!(out, "{}", shortlog(&mut commits)));
1537 try!(writeln!(out, "{}", stats));
1538 if m.is_present("patch") {
1539 try!(write_diff(out, &diff));
1540 }
1541 try!(writeln!(out, "{}", mail_signature()));
1542
1543 Ok(())
1544}
1545
1546fn main() {
1547 let m = App::new("git-series")
1548 .bin_name("git series")
1549 .about("Track patch series in git")
1550 .author("Josh Triplett <josh@joshtriplett.org>")
1551 .version(crate_version!())
1552 .global_setting(AppSettings::ColoredHelp)
1553 .global_setting(AppSettings::UnifiedHelpMessage)
1554 .global_setting(AppSettings::VersionlessSubcommands)
1555 .subcommands(vec![
1556 SubCommand::with_name("add")
1557 .about("Add changes to the index for the next series commit")
1558 .arg_from_usage("<change>... 'Changes to add (\"series\", \"base\", \"cover\")'"),
1559 SubCommand::with_name("base")
1560 .about("Get or set the base commit for the patch series")
1561 .arg(Arg::with_name("base").help("Base commit").conflicts_with("delete"))
1562 .arg_from_usage("-d, --delete 'Clear patch series base'"),
1563 SubCommand::with_name("checkout")
1564 .about("Resume work on a patch series; check out the current version")
1565 .arg_from_usage("<name> 'Patch series to check out'"),
1566 SubCommand::with_name("commit")
1567 .about("Record changes to the patch series")
1568 .arg_from_usage("-a, --all 'Commit all changes'")
1569 .arg_from_usage("-m [msg] 'Commit message'")
1570 .arg_from_usage("-v, --verbose 'Show diff when preparing commit message'"),
1571 SubCommand::with_name("cover")
1572 .about("Create or edit the cover letter for the patch series")
1573 .arg_from_usage("-d, --delete 'Delete cover letter'"),
1574 SubCommand::with_name("delete")
1575 .about("Delete a patch series")
1576 .arg_from_usage("<name> 'Patch series to delete'"),
1577 SubCommand::with_name("detach")
1578 .about("Stop working on any patch series"),
1579 SubCommand::with_name("format")
1580 .about("Prepare patch series for email")
1581 .arg_from_usage("--in-reply-to [Message-Id] 'Make the first mail a reply to the specified Message-Id'")
1582 .arg_from_usage("--no-from 'Don't include in-body \"From:\" headers when formatting patches authored by others'")
1583 .arg_from_usage("-v, --reroll-count=[N] 'Mark the patch series as PATCH vN'")
1584 .arg_from_usage("--stdout 'Write patches to stdout rather than files'"),
1585 SubCommand::with_name("log")
1586 .about("Show the history of the patch series")
1587 .arg_from_usage("-p, --patch 'Include a patch for each change committed to the series'"),
1588 SubCommand::with_name("rebase")
1589 .about("Rebase the patch series")
1590 .arg_from_usage("[onto] 'Commit to rebase onto'")
1591 .arg_from_usage("-i, --interactive 'Interactively edit the list of commits'")
1592 .group(ArgGroup::with_name("action").args(&["onto", "interactive"]).multiple(true).required(true)),
1593 SubCommand::with_name("req")
1594 .about("Generate a mail requesting a pull of the patch series")
1595 .visible_aliases(&["pull-request", "request-pull"])
1596 .arg_from_usage("-p, --patch 'Include patch in the mail'")
1597 .arg_from_usage("<url> 'Repository URL to request pull of'")
1598 .arg_from_usage("<tag> 'Tag or branch name to request pull of'"),
1599 SubCommand::with_name("status")
1600 .about("Show the status of the patch series"),
1601 SubCommand::with_name("start")
1602 .about("Start a new patch series")
1603 .arg_from_usage("<name> 'Patch series name'"),
1604 SubCommand::with_name("unadd")
1605 .about("Undo \"git series add\", removing changes from the next series commit")
1606 .arg_from_usage("<change>... 'Changes to remove (\"series\", \"base\", \"cover\")'"),
1607 ]).get_matches();
1608
1609 let mut out = Output::new();
1610
1611 let err = || -> Result<()> {
1612 let repo = try!(Repository::discover("."));
1613 match m.subcommand() {
1614 ("", _) => series(&mut out, &repo),
1615 ("add", Some(ref sm)) => add(&repo, &sm),
1616 ("base", Some(ref sm)) => base(&repo, &sm),
1617 ("checkout", Some(ref sm)) => checkout(&repo, &sm),
1618 ("commit", Some(ref sm)) => commit_status(&mut out, &repo, &sm, false),
1619 ("cover", Some(ref sm)) => cover(&repo, &sm),
1620 ("delete", Some(ref sm)) => delete(&repo, &sm),
1621 ("detach", _) => detach(&repo),
1622 ("format", Some(ref sm)) => format(&mut out, &repo, &sm),
1623 ("log", Some(ref sm)) => log(&mut out, &repo, &sm),
1624 ("rebase", Some(ref sm)) => rebase(&repo, &sm),
1625 ("req", Some(ref sm)) => req(&mut out, &repo, &sm),
1626 ("start", Some(ref sm)) => start(&repo, &sm),
1627 ("status", Some(ref sm)) => commit_status(&mut out, &repo, &sm, true),
1628 ("unadd", Some(ref sm)) => unadd(&repo, &sm),
1629 _ => unreachable!()
1630 }
1631 }();
1632
1633 if let Err(e) = err {
1634 let msg = e.to_string();
1635 out.write_err(&format!("{}{}", msg, ensure_nl(&msg)));
1636 drop(out);
1637 std::process::exit(1);
1638 }
1639}