View Javadoc

1   package org.apache.maven.scm.provider.vss.commands.checkout;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   * http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.scm.ScmFile;
23  import org.apache.maven.scm.ScmFileStatus;
24  import org.apache.maven.scm.log.ScmLogger;
25  import org.apache.maven.scm.provider.vss.commands.VssConstants;
26  import org.apache.maven.scm.provider.vss.repository.VssScmProviderRepository;
27  import org.apache.maven.scm.util.AbstractConsumer;
28  import org.codehaus.plexus.util.cli.StreamConsumer;
29  
30  import java.util.ArrayList;
31  import java.util.List;
32  
33  /**
34   * @author <a href="mailto:triek@thrx.de">Thorsten Riek</a>
35   *
36   */
37  public class VssCheckOutConsumer
38      extends AbstractConsumer
39      implements StreamConsumer
40  {
41  
42      /**
43       * expecting file information
44       */
45      private static final int GET_UNKNOWN = 0;
46  
47      /**
48       * expecting file information
49       */
50      private static final int GET_FILE = 1;
51  
52      /**
53       * expecting file information
54       */
55      private static final int REPLACE_FILE = 2;
56  
57      /**
58       * expecting file path information
59       */
60      private static final int GET_FILE_PATH = 3;
61  
62      /**
63       * expecting writable copy
64       */
65      private static final int IS_WRITABLE_COPY = 4;
66  
67      /**
68       * expecting working folder
69       */
70      private static final int SET_WORKING_FOLDER = 5;
71  
72      /**
73       * Marks start of file data
74       */
75      private static final String START_FILE_PATH = "$/";
76  
77      /**
78       * Marks getting a new File
79       */
80      private static final String START_GETTING = "Getting";
81  
82      /**
83       * Marks replacing a old File
84       */
85      private static final String START_REPLACING = "Replacing local copy of ";
86  
87      /**
88       * Marks a writable copy of a File / maybe a conflict
89       */
90      private static final String START_WRITABLE_COPY = "A writable ";
91  
92      /**
93       * Marks "Set the default folder for project" question
94       */
95      private static final String CONTAINS_SET_DEFAULT_WORKING_FOLDER = "as the default folder for project";
96  
97      private String currentPath = "";
98  
99      private List<ScmFile> updatedFiles = new ArrayList<ScmFile>();
100 
101     private VssScmProviderRepository repo;
102 
103     public VssCheckOutConsumer( VssScmProviderRepository repo, ScmLogger logger )
104     {
105         super( logger );
106         this.repo = repo;
107     }
108 
109     /** {@inheritDoc} */
110     public void consumeLine( String line )
111     {
112         if ( getLogger().isDebugEnabled() )
113         {
114             getLogger().debug( line );
115         }
116 
117         switch ( getLineStatus( line ) )
118         {
119             case GET_FILE_PATH:
120                 processGetFilePath( line );
121                 break;
122             case GET_FILE:
123                 processGetFile( line );
124                 break;
125             case REPLACE_FILE:
126                 processReplaceFile( line );
127                 break;
128             case IS_WRITABLE_COPY:
129                 // will be overwritten and uses REPLACE_FILE
130                 break;
131             case SET_WORKING_FOLDER:
132                 // to trash
133                 break;
134             default:
135                 break;
136         }
137     }
138 
139     /**
140      * Process the current input line in the Get File state.
141      *
142      * @param line a line of text from the VSS log output
143      */
144     private void processGetFile( String line )
145     {
146         String[] fileLine = line.split( " " );
147         updatedFiles.add( new ScmFile( currentPath + "/" + fileLine[1], ScmFileStatus.UPDATED ) );
148         if ( getLogger().isInfoEnabled() )
149         {
150             getLogger().info( fileLine[0] + ": " + currentPath + "/" + fileLine[1] );
151         }
152     }
153 
154     /**
155      * Process the current input line in the Replace File state.
156      *
157      * @param line a line of text from the VSS log output
158      */
159     private void processReplaceFile( String line )
160     {
161         updatedFiles.add(
162             new ScmFile( currentPath + "/" + line.substring( START_REPLACING.length() ), ScmFileStatus.UPDATED ) );
163         if ( getLogger().isInfoEnabled() )
164         {
165             getLogger().info( START_REPLACING + currentPath + "/" + line.substring( START_REPLACING.length() ) );
166         }
167     }
168 
169     /**
170      * Process the current input line in the Get File Path state.
171      *
172      * @param line a line of text from the VSS log output
173      */
174     private void processGetFilePath( String line )
175     {
176         currentPath = line.substring( ( VssConstants.PROJECT_PREFIX + repo.getProject() ).length(), line.length() - 1 );
177     }
178 
179     /**
180      * Identify the status of a vss get line
181      *
182      * @param line The line to process
183      * @return status
184      */
185     private int getLineStatus( String line )
186     {
187         int argument = GET_UNKNOWN;
188         if ( line.startsWith( START_FILE_PATH ) )
189         {
190             argument = GET_FILE_PATH;
191         }
192         else if ( line.startsWith( START_GETTING ) )
193         {
194             argument = GET_FILE;
195         }
196         else if ( line.startsWith( START_REPLACING ) )
197         {
198             argument = REPLACE_FILE;
199         }
200         else if ( line.startsWith( START_WRITABLE_COPY ) )
201         {
202             argument = IS_WRITABLE_COPY;
203         }
204         else if ( line.indexOf( CONTAINS_SET_DEFAULT_WORKING_FOLDER ) != -1 )
205         {
206             argument = SET_WORKING_FOLDER;
207         }
208 
209         return argument;
210     }
211 
212     public List<ScmFile> getUpdatedFiles()
213     {
214         return updatedFiles;
215     }
216 
217 }