Changeset 60e85e2fcb6975011b9f339476ac4aa9f427b5ba

Show
Ignore:
Timestamp:
01/28/07 13:03:34 (2 years ago)
Author:
Christopher Jung <bktheg@web.de>
git-committer:
Christopher Jung <bktheg@web.de> 1169985814 +0100
git-parent:

[ca2809a16e4654a73ac73bb9e83b50057c84c221]

git-author:
Christopher Jung <bktheg@web.de> 1169985814 +0100
Message:

Kommentare ergaenzt sowie Warnungen gefixt

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • src/net/driftingsouls/ds2/server/framework/pipeline/generators/DSGenerator.java

    rca46c31 r60e85e2  
    4343 */ 
    4444public abstract class DSGenerator extends Generator { 
     45        /** 
     46         * Die verschiedenen Aufrufarten 
     47         * 
     48         */ 
    4549        public enum ActionType { 
     50                /** 
     51                 * Eine normale HTTP-Request mit HTML-Anwort 
     52                 */ 
    4653                DEFAULT("Action"), 
     54                /** 
     55                 * Eine Ajax-Request 
     56                 */ 
    4757                AJAX("AjaxAct"); 
    4858                 
     
    5363                } 
    5464                 
     65                /** 
     66                 * Gibt den Postfix der Aktionsmethoden zurueck 
     67                 * @return Der Postfix der Aktionsmethoden 
     68                 */ 
    5569                public String getActionExt() { 
    5670                        return type; 
     
    5973         
    6074        protected abstract class FWOutputHelper { 
     75                /** 
     76                 * Gibt den Header aus 
     77                 * 
     78                 */ 
    6179                public abstract void printHeader(); 
     80                /** 
     81                 * Gibt den Footer aus 
     82                 * 
     83                 */ 
    6284                public abstract void printFooter(); 
     85                /** 
     86                 * Gibt die Fehlerliste aus 
     87                 * 
     88                 */ 
    6389                public abstract void printErrorList(); 
    6490        } 
     
    6793                @Override 
    6894                public void printHeader() { 
    69                         if( !getParameter("_style").equals("xml") ) { 
     95                        if( !getString("_style").equals("xml") ) { 
    7096                                StringBuffer sb = getResponse().getContent(); 
    7197                                String url = Configuration.getSetting("URL")+"/"; 
     
    115141                @Override 
    116142                public void printFooter() { 
    117                         if( !template.equals("") ) { 
    118                                 getTemplateEngine().parse( "OUT", masterTemplateID ); 
     143                        if( getTemplateID().length() > 0 ) { 
     144                                getTemplateEngine().parse( "OUT", getTemplateID() ); 
    119145                                         
    120146                                getTemplateEngine().p("OUT"); 
    121147                        } 
    122                         if( !getParameter("_style").equals("xml") ) { 
     148                        if( !getString("_style").equals("xml") ) { 
    123149                                StringBuffer sb = getResponse().getContent(); 
    124150                                if( !getDisableDebugOutput() ) { 
     
    178204        private FWOutputHelper actionTypeHandler; 
    179205         
    180         private String template; 
    181206        private TemplateEngine templateEngine; 
    182207        private String masterTemplateID; 
    183          
    184         private boolean noActionBlocking; 
    185         private boolean updateLastAction; 
    186208         
    187209        private boolean disableDefaultCSS; 
     
    196218        private List<String> preloadUserValues; 
    197219         
    198          
     220        /** 
     221         * Konstruktor 
     222         * @param context Der Kontext 
     223         */ 
    199224        public DSGenerator(Context context) { 
    200225                super(context); 
    201226                 
    202                 setDisableActionBlocking(false); 
    203  
    204227                parameter = new HashMap<String,Object>(); 
    205228                subParameter = ""; 
     
    222245                preloadUserValues.add("id"); 
    223246                 
    224                 template = ""; 
    225247                templateEngine = null; 
    226248                masterTemplateID = ""; 
    227                          
    228                 updateLastAction = true; 
     249 
    229250                setActionType(ActionType.DEFAULT); 
    230251 
     
    242263                this.browser = browser; 
    243264        } 
    244          
    245         @Deprecated 
    246         protected void requireUserProperty( String value ) { 
    247                 /*if( !preloadUserValues.contains(value) ) { 
    248                         preloadUserValues.add(value); 
    249                 }*/ 
    250         } 
    251          
    252         @Deprecated 
    253         protected void requireUserProperty( String ... values ) { 
    254                 for( String value : values ) { 
    255                         requireUserProperty(value);      
    256                 } 
    257         } 
    258          
     265                 
     266        /** 
     267         * Gibt den aktiven User zurueck. Falls kein User eingeloggt ist 
     268         * wird <code>null</code> zurueckgegeben 
     269         * @return Der User oder <code>null</code> 
     270         */ 
    259271        public User getUser() { 
    260272                return getActiveUser(); 
    261273        } 
    262274         
    263         public Object getParameter( String parameter ) { 
     275        private Object getParameter( String parameter ) { 
    264276                if( subParameter.equals("") ) { 
    265277                        return this.parameter.get(parameter); 
     
    355367        } 
    356368         
    357         public void parameterArray( String parameter, String[] subparams, String[] types ) { 
    358                 HashMap<String,Object> map = new HashMap<String,Object>(); 
    359                  
    360                 for( int i=0; i < subparams.length; i++ ) { 
    361                         if( "number".equals(types[i]) ) { 
    362                                 String val = getRequest().getParameter(parameter+"["+subparams[i]+"]"); 
    363                                 if( val != null ) { 
    364                                         try { 
    365                                                 map.put(subparams[i], Common.getNumberFormat().parse(val)); 
    366                                         } 
    367                                         catch( ParseException e ) { 
    368                                                 addError("Parameter "+parameter+"["+subparams[i]+"] ist keine g&uuml;ltige Zahl"); 
    369                                                 map.put(subparams[i], 0d); 
    370                                         } 
    371                                 } 
    372                                 else { 
    373                                         map.put(subparams[i], 0d); 
    374                                 } 
    375                         } 
    376                         else if( "string".equals(types[i]) ) { 
    377                                 map.put(subparams[i], getRequest().getParameter(parameter+"["+subparams[i])+"]"); 
    378                         } 
    379                 } 
    380                 this.parameter.put(parameter, map); 
    381         } 
    382          
    383369        private void createTemplateEngine() { 
    384370                if( templateEngine != null ) { 
     
    435421         */ 
    436422        public void setTemplate( String file ) { 
    437                 if( !file.equals("") ) { 
    438                         template = file; 
    439                  
     423                if( !file.equals("") ) {                 
    440424                        if( templateEngine == null ) { 
    441425                                createTemplateEngine(); 
     
    452436                        if( !templateEngine.set_file( masterTemplateID, file ) ) { 
    453437                                masterTemplateID = ""; 
    454                                 template = "";   
    455438                        } 
    456439                } 
    457440                else { 
    458                         template = ""; 
    459441                        masterTemplateID = "";   
    460442                } 
     
    486468        } 
    487469         
     470        /** 
     471         * Fueht die angegebene Aktion aus 
     472         * @param action Der Name der Aktion 
     473         * @param actionType Der Typ der Aktion 
     474         */ 
    488475        public void handleAction( String action, ActionType actionType ) { 
    489476                setActionType( actionType ); 
     
    499486                 
    500487                if( getErrorList().length != 0 ) { 
    501                         template = ""; 
    502                          
     488                        masterTemplateID = ""; 
    503489                        actionTypeHandler.printHeader(); 
    504490                         
     
    552538                        } 
    553539                } 
    554                 else {                          
    555                         template = "";  
     540                else { 
     541                        masterTemplateID = ""; 
    556542                } 
    557543                parseSubParameter(""); 
     
    579565        } 
    580566         
     567        /** 
     568         * Gibt an, ob fuer die Ausfuehrung einer Aktion eine gueltige Session 
     569         * erforderlich ist (also, dass der Benutzer angemeldet ist) 
     570         * @param value <code>true</code>, falls eine gueltige Session erforderlich ist 
     571         */ 
    581572        public void requireValidSession( boolean value ) { 
    582573                requireValidSession = value; 
    583574        } 
    584575         
     576        /** 
     577         * (De)aktiviert die Debug-Ausgaben 
     578         * @param value <code>true</code> zur Deaktivierung 
     579         */ 
    585580        public void setDisableDebugOutput( boolean value ) { 
    586581                disableDebugOutput = value; 
    587582        } 
    588583         
     584        /** 
     585         * Gibt zurueck, ob die Debugausgabe deaktiviert ist 
     586         * @return <code>true</code>, falls sie deaktiviert ist 
     587         */ 
    589588        public boolean getDisableDebugOutput() { 
    590589                return disableDebugOutput;       
    591590        } 
    592591         
     592        /** 
     593         * (De)aktiviert die Default-CSS-Stile 
     594         * @param value <code>true</code> zur Deaktivierung 
     595         */ 
    593596        public void setDisableDefaultCSS( boolean value ) { 
    594597                disableDefaultCSS = value; 
    595598        } 
    596599         
     600        /** 
     601         * Gibt zurueck, ob die Default-CSS-Stile deaktiviert sind 
     602         * @return <code>true</code>, falls sie deaktiviert sind 
     603         */ 
    597604        public boolean getDisableDefaultCSS() { 
    598605                return disableDefaultCSS;        
    599606        } 
    600607         
    601         @Deprecated 
    602         public void setDisableActionBlocking( boolean value ) { 
    603                 noActionBlocking = value;        
    604         } 
    605          
    606         @Deprecated 
    607         public void setDisableLastActionUpdate( boolean value ) { 
    608                 updateLastAction = !value;       
    609         } 
    610          
     608        /** 
     609         * Gibt den Startzeitpunkt der Verarbeitung zurueck 
     610         * @return Der Startzeitpunkt der Verarbeitung 
     611         */ 
    611612        public long getStartTime() { 
    612613                return startTime; 
    613614        } 
    614615 
     616        /** 
     617         * Gibt das <code>onLoad</code>-Attribut des HTML-Body-Tags zurueck 
     618         * @return Das <code>onLoad</code>-Attribut 
     619         */ 
    615620        public String getOnLoadText() { 
    616621                if( onLoadFunctions.size() > 0 ) { 
     
    625630        } 
    626631         
     632        /** 
     633         * Fuegt eine Javascript-Funktion zum <code>onLoad</code>-Aufruf des Body-Tags hinzu 
     634         * @param func Der Javascript-Funktionsaufruf 
     635         */ 
    627636        public void addOnLoadFunction( String func ) { 
    628637                onLoadFunctions.add(func); 
    629638        } 
    630639         
     640        /** 
     641         * Gibt weitere HTML-Body-Tag-Attribute zurueck 
     642         * @return Weitere HTML-Body-Tag-Attribute 
     643         * @see #getOnLoadText() 
     644         */ 
    631645        public String getBodyParameters() { 
    632646                StringBuilder text = new StringBuilder(); 
     
    641655        } 
    642656         
     657        /** 
     658         * Fuegt ein weiteres HTML-Body-Tag-Attribut hinzu. 
     659         * Sollte das Attribut bereits gesetzt seit, so wird es 
     660         * ueberschrieben 
     661         * @param parameter Der Name des Attributs 
     662         * @param value Der Wert 
     663         */ 
    643664        public void addBodyParameter( String parameter, String value ) { 
    644665                bodyParameters.put(parameter,value); 
    645666        } 
    646667         
     668        /** 
     669         * Gibt den Identifikationsstring des Browsers des Spielers zurueck 
     670         * @return Der Identifikationsstring des Browsers 
     671         */ 
    647672        public String getBrowser() { 
    648673                return browser; 
     
    662687        protected abstract boolean validateAndPrepare(String action); 
    663688         
     689        /** 
     690         * Die Default-Ajax-Aktion 
     691         * 
     692         */ 
    664693        public void defaultAjaxAct() { 
    665694                defaultAction();         
    666695        } 
    667696         
     697        /** 
     698         * Die Default-HTML-Aktion 
     699         * 
     700         */ 
    668701        public void defaultAction() { 
    669702                getResponse().getContent().append("DEFAULT");