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