Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 06e7fe4d29156917291234bd2b2ccfc4327c6781 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
/*******************************************************************************
 * Copyright (c) 2000, 2004 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.team.internal.ccvs.core.client.listeners;

import java.util.*;

import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.team.internal.ccvs.core.*;
import org.eclipse.team.internal.ccvs.core.client.CommandOutputListener;
import org.eclipse.team.internal.ccvs.core.resources.RemoteFile;
import org.eclipse.team.internal.ccvs.core.util.Util;

/**
 * Log listener that parses the log entries returned from the
 * server but delegates the handling of the entries to a subclass.
 */
public class LogListener extends CommandOutputListener {
    
    // Server message prefix used for error detection
    private static final String NOTHING_KNOWN_ABOUT = "nothing known about "; //$NON-NLS-1$

    // States of log accumulation.
    private final int DONE = 4;
    private final int COMMENT = 3;
    private final int REVISION = 2;
    private final int SYMBOLIC_NAMES = 1;
    private final int BEGIN = 0;
    
    // Instance variables for accumulating Log information
    private RemoteFile currentFile;
    private int state = BEGIN;
    private StringBuffer comment;
    private String fileState;
    private String revision;
    private String author;
    private String creationDate;
    private List tagRevisions = new ArrayList(5);
    private List tagNames = new ArrayList(5);
    
    private final ILogEntryListener listener;
    
    /**
     * Create a log listener for receiving entries for one or more files.
     */
    public LogListener(ILogEntryListener listener) {
        this.listener = listener;
    }

    public LogListener(RemoteFile file, ILogEntryListener listener) {
        this(listener);
        this.currentFile = file;   
    }

    private String getRelativeFilePath(ICVSRepositoryLocation location, String fileName) {
    	if (fileName.endsWith(",v")) { //$NON-NLS-1$
    		fileName = fileName.substring(0, fileName.length() - 2);
    	}
    	fileName = Util.removeAtticSegment(fileName);
    	String rootDirectory = location.getRootDirectory();
    	if (fileName.startsWith(rootDirectory)) {
    		try {
    			fileName = Util.getRelativePath(rootDirectory, fileName);
    		} catch (CVSException e) {
    			CVSProviderPlugin.log(e);
    			return null;
    		}
    	}
    	return fileName;
    }

    public IStatus errorLine(String line, ICVSRepositoryLocation location, ICVSFolder commandRoot, IProgressMonitor monitor) {
    	String serverMessage = getServerMessage(line, location);
    	if (serverMessage != null) {
    		// look for the following condition
    		// E cvs server: nothing known about fileName
    		if (serverMessage.startsWith(NOTHING_KNOWN_ABOUT)) {
    			return new CVSStatus(IStatus.ERROR, CVSStatus.DOES_NOT_EXIST, commandRoot, line);
    		}
    	}
    	return OK;
    }

    public IStatus messageLine(String line, ICVSRepositoryLocation location, ICVSFolder commandRoot, IProgressMonitor monitor) {
    	// Fields we will find in the log for a file
    	// keys = String (tag name), values = String (tag revision number) */
    	switch (state) {
    		case BEGIN:
    			if (line.startsWith("RCS file: ")) { //$NON-NLS-1$
    				// We are starting to recieve the log for a file
    				String fileName = getRelativeFilePath(location, line.substring(10).trim());
    				if (fileName == null) {
    				    currentFile = null;
    					handleInvalidFileName(location, fileName);
    				} else {
    			        if (currentFile == null || !currentFile.getRepositoryRelativePath().equals(fileName)) {
    			        	// We are starting another file
    			        	beginFile(location, fileName);
    			        }
    				}
    			} else  if (line.startsWith("symbolic names:")) { //$NON-NLS-1$
    				state = SYMBOLIC_NAMES;
    			} else if (line.startsWith("revision ")) { //$NON-NLS-1$
    				revision = line.substring(9);
    				state = REVISION;
    			}
    			break;
    		case SYMBOLIC_NAMES:
    			if (line.startsWith("keyword substitution:")) { //$NON-NLS-1$
    				state = BEGIN;
    			} else {
    				int firstColon = line.indexOf(':');
    				String tagName = line.substring(1, firstColon);
    				String tagRevision = line.substring(firstColon + 2);
    				tagNames.add(tagName);
    				tagRevisions.add(tagRevision);
    			}
    			break;
    		case REVISION:
    			// date: 2000/06/19 04:56:21;  author: somebody;  state: Exp;  lines: +114 -45
    			// get the creation date
    			int endOfDateIndex = line.indexOf(';', 6);
    			creationDate = line.substring(6, endOfDateIndex) + " GMT"; //$NON-NLS-1$
    
    			// get the author name
    			int endOfAuthorIndex = line.indexOf(';', endOfDateIndex + 1);
    			author = line.substring(endOfDateIndex + 11, endOfAuthorIndex);
    
    			// get the file state (because this revision might be "dead")
    			fileState = line.substring(endOfAuthorIndex + 10, line.indexOf(';', endOfAuthorIndex + 1));
    			comment = new StringBuffer();
    			state = COMMENT;
    			break;
    		case COMMENT:
    			// skip next line (info about branches) if it exists, if not then it is a comment line.
    			if (line.startsWith("branches:")) break; //$NON-NLS-1$
    			if (line.equals("=============================================================================") //$NON-NLS-1$
    				|| line.equals("----------------------------")) { //$NON-NLS-1$
    				state = DONE;
    				break;
    			}
    			if (comment.length() != 0) comment.append('\n');
    			comment.append(line);
    			break;
    	}
    	if (state == DONE) {
    		// we are only interested in tag names for this revision, remove all others.
    		List thisRevisionTags = new ArrayList(3);
    		for (int i = 0; i < tagNames.size(); i++) {
    			String tagName = (String) tagNames.get(i);
    			String tagRevision = (String) tagRevisions.get(i);
    			// If this is a branch tag then only include this tag with the revision
    			// that is the root of this branch (e.g. 1.1 is root of branch 1.1.2).
    			boolean isBranch = isBranchTag(tagRevision);
    			if (isBranch) {
    				int lastDot = tagRevision.lastIndexOf('.');
    				if (lastDot == -1) {
    					CVSProviderPlugin.log(IStatus.ERROR, 
    						Policy.bind("LogListener.invalidRevisionFormat", tagName, tagRevision), null); //$NON-NLS-1$
    				} else {
    					if (tagRevision.charAt(lastDot - 1) == '0' && tagRevision.charAt(lastDot - 2) == '.') {
    						lastDot = lastDot - 2;
    					}
    					tagRevision = tagRevision.substring(0, lastDot);
    				}
    			}
    			if (tagRevision.equals(revision)) {
    				int type = isBranch ? CVSTag.BRANCH : CVSTag.VERSION;
    				thisRevisionTags.add(new CVSTag(tagName, type));
    			}
    		}
    		Date date = DateUtil.convertFromLogTime(creationDate);
    		if (currentFile != null) {
    			LogEntry entry = new LogEntry(currentFile, revision, author, date,
    				comment.toString(), fileState, (CVSTag[]) thisRevisionTags.toArray(new CVSTag[0]));
    			addEntry(entry);
    		}
    		state = BEGIN;
    	}
    	return OK;
    }

    protected void beginFile(ICVSRepositoryLocation location, String fileName) {
    	currentFile = RemoteFile.create(fileName, location);
    	tagNames.clear();
    	tagRevisions.clear();  
    }

    protected void addEntry(LogEntry entry) {
        listener.handleLogEntryReceived(entry);
    }

    protected void handleInvalidFileName(ICVSRepositoryLocation location, String badFilePath) {
        CVSProviderPlugin.log(IStatus.WARNING, "Invalid file path '" + badFilePath + "' received from " + location.toString(), null);
    }

    /** branch tags have odd number of segments or have
     *  an even number with a zero as the second last segment
     *  e.g: 1.1.1, 1.26.0.2 are branch revision numbers */
    protected boolean isBranchTag(String tagName) {
    	// First check if we have an odd number of segments (i.e. even number of dots)
    	int numberOfDots = 0;
    	int lastDot = 0;
    	for (int i = 0; i < tagName.length(); i++) {
    		if (tagName.charAt(i) == '.') {
    			numberOfDots++;
    			lastDot = i;
    		}
    	}
    	if ((numberOfDots % 2) == 0) return true;
    	if (numberOfDots == 1) return false;
    	
    	// If not, check if the second lat segment is a zero
    	if (tagName.charAt(lastDot - 1) == '0' && tagName.charAt(lastDot - 2) == '.') return true;
    	return false;
    }

}

Back to the top