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

   1 package org.apache.archiva.web.action;
   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.ActionContext;
  23 import com.opensymphony.xwork2.ActionSupport;
  24 import org.apache.archiva.admin.model.AuditInformation;
  25 import org.apache.archiva.audit.AuditEvent;
  26 import org.apache.archiva.audit.AuditListener;
  27 import org.apache.archiva.audit.Auditable;
  28 import org.apache.archiva.metadata.repository.RepositorySessionFactory;
  29 import org.apache.archiva.security.ArchivaXworkUser;
  30 import org.apache.commons.lang.StringUtils;
  31 import org.apache.commons.lang.math.NumberUtils;
  32 import org.apache.struts2.ServletActionContext;
  33 import org.apache.struts2.interceptor.SessionAware;
  34 import org.codehaus.plexus.redback.users.User;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37 import org.springframework.context.ApplicationContext;
  38
  39 import javax.annotation.PostConstruct;
  40 import javax.inject.Inject;
  41 import javax.inject.Named;
  42 import javax.servlet.http.HttpServletRequest;
  43 import java.text.SimpleDateFormat;
  44 import java.util.ArrayList;
  45 import java.util.Date;
  46 import java.util.HashMap;
  47 import java.util.List;
  48 import java.util.Map;
  49 import java.util.Properties;
  50
  51 /**
  52  * LogEnabled and SessionAware ActionSupport
  53  */
  54 public abstract class AbstractActionSupport
  55     extends ActionSupport
  56     implements SessionAware, Auditable
  57 {
  58     protected Map<?, ?> session;
  59
  60     protected Logger log = LoggerFactory.getLogger( getClass() );
  61
  62     @Inject
  63     private List<AuditListener> auditListeners = new ArrayList<AuditListener>();
  64
  65
  66     @Inject
  67     @Named( value = "repositorySessionFactory" )
  68     protected RepositorySessionFactory repositorySessionFactory;
  69
  70     @Inject
  71     protected ApplicationContext applicationContext;
  72
  73     private String principal;
  74
  75     @Inject
  76     @Named( value = "archivaRuntimeProperties" )
  77     private Properties archivaRuntimeProperties;
  78
  79     @PostConstruct
  80     public void initialize()
  81     {
  82         // no op
  83     }
  84
  85     @SuppressWarnings( "unchecked" )
  86     public void setSession( Map map )
  87     {
  88         this.session = map;
  89     }
  90
  91     public void addAuditListener( AuditListener listener )
  92     {
  93         this.auditListeners.add( listener );
  94     }
  95
  96     public void clearAuditListeners()
  97     {
  98         this.auditListeners.clear();
  99     }
 100
 101     public void removeAuditListener( AuditListener listener )
 102     {
 103         this.auditListeners.remove( listener );
 104     }
 105
 106     protected void triggerAuditEvent( String repositoryId, String resource, String action )
 107     {
 108         AuditEvent event = new AuditEvent( repositoryId, getPrincipal(), resource, action );
 109         event.setRemoteIP( getRemoteAddr() );
 110
 111         for ( AuditListener listener : auditListeners )
 112         {
 113             listener.auditEvent( event );
 114         }
 115     }
 116
 117     protected void triggerAuditEvent( String resource, String action )
 118     {
 119         AuditEvent event = new AuditEvent( null, getPrincipal(), resource, action );
 120         event.setRemoteIP( getRemoteAddr() );
 121
 122         for ( AuditListener listener : auditListeners )
 123         {
 124             listener.auditEvent( event );
 125         }
 126     }
 127
 128     protected void triggerAuditEvent( String action )
 129     {
 130         AuditEvent event = new AuditEvent( null, getPrincipal(), null, action );
 131         event.setRemoteIP( getRemoteAddr() );
 132
 133         for ( AuditListener listener : auditListeners )
 134         {
 135             listener.auditEvent( event );
 136         }
 137     }
 138
 139     private String getRemoteAddr()
 140     {
 141         HttpServletRequest request = ServletActionContext.getRequest();
 142         return request != null ? request.getRemoteAddr() : null;
 143     }
 144
 145     @SuppressWarnings( "unchecked" )
 146     protected String getPrincipal()
 147     {
 148         if ( principal != null )
 149         {
 150             return principal;
 151         }
 152         return ArchivaXworkUser.getActivePrincipal( ActionContext.getContext().getSession() );
 153     }
 154
 155     void setPrincipal( String principal )
 156     {
 157         this.principal = principal;
 158     }
 159
 160     public void setAuditListeners( List<AuditListener> auditListeners )
 161     {
 162         this.auditListeners = auditListeners;
 163     }
 164
 165     public void setRepositorySessionFactory( RepositorySessionFactory repositorySessionFactory )
 166     {
 167         this.repositorySessionFactory = repositorySessionFactory;
 168     }
 169
 170     protected <T> Map<String, T> getBeansOfType( Class<T> clazz )
 171     {
 172         //TODO do some caching here !!!
 173         // olamy : with plexus we get only roleHint
 174         // as per convention we named spring bean role#hint remove role# if exists
 175         Map<String, T> springBeans = applicationContext.getBeansOfType( clazz );
 176
 177         Map<String, T> beans = new HashMap<String, T>( springBeans.size() );
 178
 179         for ( Map.Entry<String, T> entry : springBeans.entrySet() )
 180         {
 181             String key = StringUtils.substringAfterLast( entry.getKey(), "#" );
 182             beans.put( key, entry.getValue() );
 183         }
 184         return beans;
 185     }
 186
 187
 188     protected AuditInformation getAuditInformation()
 189     {
 190         AuditInformation auditInformation = new AuditInformation( new SimpleUser( getPrincipal() ), getRemoteAddr() );
 191
 192         return auditInformation;
 193     }
 194
 195     public String getArchivaVersion()
 196     {
 197         return (String) archivaRuntimeProperties.get( "archiva.version" );
 198     }
 199
 200     public String getArchivaBuildNumber()
 201     {
 202         return (String) archivaRuntimeProperties.get( "archiva.buildNumber" );
 203     }
 204
 205     public String getArchivaBuildTimestamp()
 206     {
 207         return (String) archivaRuntimeProperties.get( "archiva.timestamp" );
 208     }
 209
 210     public String getArchivaBuildTimestampDateStr()
 211     {
 212         SimpleDateFormat sfd = new SimpleDateFormat( "yyyy-MM-dd'T'HH:mm:ssz", getLocale() );
 213         return sfd.format(
 214             new Date( NumberUtils.createLong( (String) archivaRuntimeProperties.get( "archiva.timestamp" ) ) ) );
 215     }
 216
 217     /**
 218      * dummy information for audit events
 219      *
 220      * @since 1.4
 221      */
 222     private static class SimpleUser
 223         implements User
 224     {
 225
 226         private String principal;
 227
 228         protected SimpleUser( String principal )
 229         {
 230             this.principal = principal;
 231         }
 232
 233         public Object getPrincipal()
 234         {
 235             return this.principal;
 236         }
 237
 238         public String getUsername()
 239         {
 240             return null;
 241         }
 242
 243         public void setUsername( String name )
 244         {
 245
 246         }
 247
 248         public String getFullName()
 249         {
 250             return null;
 251         }
 252
 253         public void setFullName( String name )
 254         {
 255
 256         }
 257
 258         public String getEmail()
 259         {
 260             return null;
 261         }
 262
 263         public void setEmail( String address )
 264         {
 265
 266         }
 267
 268         public String getPassword()
 269         {
 270             return null;
 271         }
 272
 273         public void setPassword( String rawPassword )
 274         {
 275
 276         }
 277
 278         public String getEncodedPassword()
 279         {
 280             return null;
 281         }
 282
 283         public void setEncodedPassword( String encodedPassword )
 284         {
 285
 286         }
 287
 288         public Date getLastPasswordChange()
 289         {
 290             return null;
 291         }
 292
 293         public void setLastPasswordChange( Date passwordChangeDate )
 294         {
 295
 296         }
 297
 298         public List<String> getPreviousEncodedPasswords()
 299         {
 300             return null;
 301         }
 302
 303         public void setPreviousEncodedPasswords( List<String> encodedPasswordList )
 304         {
 305
 306         }
 307
 308         public void addPreviousEncodedPassword( String encodedPassword )
 309         {
 310
 311         }
 312
 313         public boolean isPermanent()
 314         {
 315             return false;
 316         }
 317
 318         public void setPermanent( boolean permanent )
 319         {
 320
 321         }
 322
 323         public boolean isLocked()
 324         {
 325             return false;
 326         }
 327
 328         public void setLocked( boolean locked )
 329         {
 330
 331         }
 332
 333         public boolean isPasswordChangeRequired()
 334         {
 335             return false;
 336         }
 337
 338         public void setPasswordChangeRequired( boolean changeRequired )
 339         {
 340
 341         }
 342
 343         public boolean isValidated()
 344         {
 345             return false;
 346         }
 347
 348         public void setValidated( boolean valid )
 349         {
 350
 351         }
 352
 353         public int getCountFailedLoginAttempts()
 354         {
 355             return 0;
 356         }
 357
 358         public void setCountFailedLoginAttempts( int count )
 359         {
 360
 361         }
 362
 363         public Date getAccountCreationDate()
 364         {
 365             return null;
 366         }
 367
 368         public void setAccountCreationDate( Date date )
 369         {
 370
 371         }
 372
 373         public Date getLastLoginDate()
 374         {
 375             return null;
 376         }
 377
 378         public void setLastLoginDate( Date date )
 379         {
 380
 381         }
 382     }
 383
 384
 385 }