source.dussan.org Git - archiva.git/blob

   1 package org.apache.archiva.web.action.reports;
   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 com.opensymphony.xwork2.Preparable;
  23 import org.apache.archiva.audit.AuditEvent;
  24 import org.apache.archiva.audit.AuditManager;
  25 import org.apache.archiva.metadata.repository.RepositorySession;
  26 import org.apache.commons.lang.StringUtils;
  27 import org.apache.commons.lang.time.DateUtils;
  28 import org.apache.archiva.security.AccessDeniedException;
  29 import org.apache.archiva.security.ArchivaSecurityException;
  30 import org.apache.archiva.security.PrincipalNotFoundException;
  31 import org.apache.archiva.security.UserRepositories;
  32 import org.apache.archiva.web.action.AbstractActionSupport;
  33 import org.apache.struts2.interceptor.ServletRequestAware;
  34 import org.apache.archiva.redback.integration.interceptor.SecureAction;
  35 import org.apache.archiva.redback.integration.interceptor.SecureActionBundle;
  36 import org.apache.archiva.redback.integration.interceptor.SecureActionException;
  37 import org.springframework.context.annotation.Scope;
  38 import org.springframework.stereotype.Controller;
  39
  40 import javax.inject.Inject;
  41 import javax.servlet.http.HttpServletRequest;
  42 import java.util.ArrayList;
  43 import java.util.Calendar;
  44 import java.util.Collection;
  45 import java.util.Collections;
  46 import java.util.Date;
  47 import java.util.List;
  48
  49 /**
  50  *
  51  */
  52 @Controller( "viewAuditLogReport" )
  53 @Scope( "prototype" )
  54 public class ViewAuditLogReportAction
  55     extends AbstractActionSupport
  56     implements SecureAction, ServletRequestAware, Preparable
  57 {
  58     protected HttpServletRequest request;
  59
  60     @Inject
  61     private UserRepositories userRepositories;
  62
  63     @Inject
  64     private AuditManager auditManager;
  65
  66     private String repository;
  67
  68     private List<String> repositories;
  69
  70     private String groupId;
  71
  72     private String artifactId;
  73
  74     private String startDate;
  75
  76     private String endDate;
  77
  78     private int rowCount = 30;
  79
  80     private int page = 1;
  81
  82     protected boolean isLastPage = true;
  83
  84     private List<AuditEvent> auditLogs;
  85
  86     private static final String ALL_REPOSITORIES = "all";
  87
  88     private String initial = "true";
  89
  90     private String headerName;
  91
  92     private static final String HEADER_LATEST_EVENTS = "Latest Events";
  93
  94     private static final String HEADER_RESULTS = "Results";
  95
  96     private String[] datePatterns =
  97     new String[]{ "MM/dd/yy", "MM/dd/yyyy", "MMMMM/dd/yyyy", "MMMMM/dd/yy", "dd MMMMM yyyy", "dd/MM/yy",
  98     "dd/MM/yyyy", "yyyy/MM/dd", "yyyy-MM-dd", "yyyy-dd-MM", "MM-dd-yyyy", "MM-dd-yy" };
  99
 100
 101
 102     public SecureActionBundle getSecureActionBundle()
 103         throws SecureActionException
 104     {
 105         SecureActionBundle bundle = new SecureActionBundle();
 106
 107         // TODO: should require this, but for now we trust in the list of repositories
 108 //        bundle.setRequiresAuthentication( true );
 109 //        bundle.addRequiredAuthorization( ArchivaRoleConstants.OPERATION_VIEW_AUDIT_LOG );
 110
 111         return bundle;
 112     }
 113
 114     public void setServletRequest( HttpServletRequest request )
 115     {
 116         this.request = request;
 117     }
 118
 119     @SuppressWarnings( "unchecked" )
 120     public void prepare()
 121         throws Exception
 122     {
 123         repositories = new ArrayList<String>();
 124         repositories.add( ALL_REPOSITORIES );
 125         List<String> repos = getManagableRepositories();
 126         repositories.addAll( repos );
 127
 128         auditLogs = null;
 129         groupId = "";
 130         artifactId = "";
 131         repository = "";
 132
 133         if ( Boolean.parseBoolean( initial ) )
 134         {
 135             headerName = HEADER_LATEST_EVENTS;
 136         }
 137         else
 138         {
 139             headerName = HEADER_RESULTS;
 140         }
 141
 142         RepositorySession repositorySession = repositorySessionFactory.createSession();
 143         try
 144         {
 145             auditLogs = auditManager.getMostRecentAuditEvents( repositorySession.getRepository(), repos );
 146         }
 147         finally
 148         {
 149             repositorySession.close();
 150         }
 151     }
 152
 153     public String execute()
 154         throws Exception
 155     {
 156         Date startDateInDF = null;
 157         Date endDateInDF = null;
 158         if ( !StringUtils.isEmpty( startDate ) )
 159         {
 160             startDateInDF = DateUtils.parseDate( startDate, datePatterns );
 161         }
 162
 163         if ( !StringUtils.isEmpty( endDate ) )
 164         {
 165             endDateInDF = DateUtils.parseDate( endDate, datePatterns );
 166             Calendar cal = Calendar.getInstance();
 167             cal.setTime( endDateInDF );
 168             cal.set( Calendar.HOUR, 23 );
 169             cal.set( Calendar.MINUTE, 59 );
 170             cal.set( Calendar.SECOND, 59 );
 171
 172             endDateInDF = cal.getTime();
 173         }
 174
 175         Collection<String> repos = getManagableRepositories();
 176         if ( !repository.equals( ALL_REPOSITORIES ) )
 177         {
 178             if ( repos.contains( repository ) )
 179             {
 180                 repos = Collections.singletonList( repository );
 181             }
 182             else
 183             {
 184                 repos = Collections.emptyList();
 185             }
 186         }
 187
 188         if ( StringUtils.isEmpty( groupId ) && !StringUtils.isEmpty( artifactId ) )
 189         {
 190             // Until we store the full artifact metadata in the audit event, we can't query by these individually
 191             addActionError( "If you specify an artifact ID, you must specify a group ID" );
 192             auditLogs = null;
 193             return INPUT;
 194         }
 195
 196         String resource = null;
 197         if ( !StringUtils.isEmpty( groupId ) )
 198         {
 199             String groupIdAsPath = groupId.replace( '.', '/' );
 200             if ( StringUtils.isEmpty( artifactId ) )
 201             {
 202                 resource = groupIdAsPath;
 203             }
 204             else
 205             {
 206                 resource = groupIdAsPath + "/" + artifactId;
 207             }
 208         }
 209
 210         RepositorySession repositorySession = repositorySessionFactory.createSession();
 211         try
 212         {
 213             auditLogs =
 214                 auditManager.getAuditEventsInRange( repositorySession.getRepository(), repos, resource, startDateInDF,
 215                                                     endDateInDF );
 216         }
 217         finally
 218         {
 219             repositorySession.close();
 220         }
 221
 222         headerName = HEADER_RESULTS;
 223
 224         if ( auditLogs.isEmpty() )
 225         {
 226             addActionError( "No audit logs found." );
 227             initial = "true";
 228             return SUCCESS;
 229         }
 230         else
 231         {
 232             initial = "false";
 233             return paginate();
 234         }
 235     }
 236
 237     private String paginate()
 238     {
 239         int rowCount = getRowCount();
 240         int extraPage = ( auditLogs.size() % rowCount ) != 0 ? 1 : 0;
 241         int totalPages = ( auditLogs.size() / rowCount ) + extraPage;
 242
 243         int currentPage = getPage();
 244         if ( currentPage > totalPages )
 245         {
 246             addActionError(
 247                 "Error encountered while generating report :: The requested page exceeds the total number of pages." );
 248             return ERROR;
 249         }
 250
 251         if ( currentPage == totalPages )
 252         {
 253             isLastPage = true;
 254         }
 255         else
 256         {
 257             isLastPage = false;
 258         }
 259
 260         int start = rowCount * ( currentPage - 1 );
 261         int end = ( start + rowCount ) - 1;
 262
 263         if ( end >= auditLogs.size() )
 264         {
 265             end = auditLogs.size() - 1;
 266         }
 267
 268         auditLogs = auditLogs.subList( start, end + 1 );
 269
 270         return SUCCESS;
 271     }
 272
 273     private List<String> getManagableRepositories()
 274     {
 275         try
 276         {
 277             return userRepositories.getManagableRepositoryIds( getPrincipal() );
 278         }
 279         catch ( PrincipalNotFoundException e )
 280         {
 281             log.warn( e.getMessage(), e );
 282         }
 283         catch ( AccessDeniedException e )
 284         {
 285             log.warn( e.getMessage(), e );
 286         }
 287         catch ( ArchivaSecurityException e )
 288         {
 289             log.warn( e.getMessage(), e );
 290         }
 291         return Collections.emptyList();
 292     }
 293
 294     public String getRepository()
 295     {
 296         return repository;
 297     }
 298
 299     public void setRepository( String repository )
 300     {
 301         this.repository = repository;
 302     }
 303
 304     public List<String> getRepositories()
 305     {
 306         return repositories;
 307     }
 308
 309     public void setRepositories( List<String> repositories )
 310     {
 311         this.repositories = repositories;
 312     }
 313
 314     public String getGroupId()
 315     {
 316         return groupId;
 317     }
 318
 319     public void setGroupId( String groupId )
 320     {
 321         this.groupId = groupId;
 322     }
 323
 324     public String getArtifactId()
 325     {
 326         return artifactId;
 327     }
 328
 329     public void setArtifactId( String artifactId )
 330     {
 331         this.artifactId = artifactId;
 332     }
 333
 334     public List<AuditEvent> getAuditLogs()
 335     {
 336         return auditLogs;
 337     }
 338
 339     public int getRowCount()
 340     {
 341         return rowCount;
 342     }
 343
 344     public void setRowCount( int rowCount )
 345     {
 346         this.rowCount = rowCount;
 347     }
 348
 349     public String getStartDate()
 350     {
 351         return startDate;
 352     }
 353
 354     public void setStartDate( String startDate )
 355     {
 356         this.startDate = startDate;
 357     }
 358
 359     public String getEndDate()
 360     {
 361         return endDate;
 362     }
 363
 364     public void setEndDate( String endDate )
 365     {
 366         this.endDate = endDate;
 367     }
 368
 369     public int getPage()
 370     {
 371         return page;
 372     }
 373
 374     public void setPage( int page )
 375     {
 376         this.page = page;
 377     }
 378
 379     public boolean getIsLastPage()
 380     {
 381         return isLastPage;
 382     }
 383
 384     public void setIsLastPage( boolean isLastPage )
 385     {
 386         this.isLastPage = isLastPage;
 387     }
 388
 389     public String getInitial()
 390     {
 391         return initial;
 392     }
 393
 394     public void setInitial( String initial )
 395     {
 396         this.initial = initial;
 397     }
 398
 399     public String getHeaderName()
 400     {
 401         return headerName;
 402     }
 403
 404     public void setHeaderName( String headerName )
 405     {
 406         this.headerName = headerName;
 407     }
 408 }