Changeset 11103

Timestamp:

05/22/12 20:49:33 (13 months ago)

Author:

edent

Message:

add more documentation and remove unnecessary methodes

Location:

ossiedev/branches/jsnyder/trunk/tools/cornetApps

Files:

• DomainMan/views.py (modified) (17 diffs)
• LoginUser/views.py (modified) (1 diff)
• cornetApps.db (modified) (previous)
• settings.py (modified) (2 diffs)
• settingsWeb.py (modified) (1 diff)
• urls.py (modified) (1 diff)

ossiedev/branches/jsnyder/trunk/tools/cornetApps/DomainMan/views.py

@@ -12 +12 @@
 """
 
-"""Checks if running locally or on the web by testing which Django settings are used
+"""
+Checks if running locally or on the web by testing which Django settings are used
 """
 def isOnWeb():
@@ -36 +37 @@
 Connects to a node given its floor and number
 Returns the SSHClient connected to the server
+@param floor The floor of the node to connect to
+@param num The number of the node to connect to
+@param user The username to login with
+@param password The password of the user to login with
+@return The SSHClient connected to the server
 """
 def connectViaNode(floor, num, user, password):
@@ -71 +77 @@
     return 0
 
-'''
+"""
 Starts default nodeBooter at a given ip and port
 @param ip: The ip address of the server for the nodes
@@ -77 +83 @@
 @param user: The user's username with access to the node
 @param password: The user's password
-'''
+"""
 def startNodebooter(request, floor, num, user, password):
     floor = int(floor)
@@ -106 +112 @@
     return
 
-"""Populate the list of device managers
+"""
+Populate the list of device managers from a given node
+@param floor The floor of the node to connect to
+@param num The number of the node to connect to
+@param user The username to login with
+@param password The password of the user to login with
+@return An array of the list of device managers on the node
 """
 def getDeviceManagers(floor, num, user, password):
@@ -115 +127 @@
     return stdout.readlines()
  
-"""View for displaying device and domain managers
+"""
+View for displaying device and domain managers
+@param request The Django request parameter for views
+@param floor The floor of the node to connect to
+@param num The number of the node to connect to
+@param user The username to login with
+@param password The password of the user to login with
+@return HttpResponse object with template and local context dictionary or
+    Http404 if could not find user and password session variables
 """
 def manager_view(request, floor, num, user, password):
@@ -122 +142 @@
         request.session["user"] = user
         request.session["password"] = password
-        print "user: "+user, password
     except:
         raise Http404(u'Could not set user and password in session variables')
@@ -133 +152 @@
 """
 Start a device manager and a domain manager
+checks post and session variables.
+execute command based domain and device manager options
+@param request The Django request parameter for views
+@return HttpResponse object with template and local context dictionary or
+    Http404 if could not find user and password session variables
 """
 def startManager(request):
@@ -161 +185 @@
 """
 Gets the parameters to run domain manager
+@param request The Django request parameter for views
+@return The correct command based on the domainLocation session variable
+    -D if the domain manager is located on the same node
+    nothing if the domain manager is located on a remote node
 """
 def getDomain(request):
@@ -174 +202 @@
 """
 Gets the device manager's xml file to run based on a given POST request
+@param request The Django request parameter for views
+@return The string command for the device manager xml file
+    returns Http404 if cannot find the device parameter in the post request
 """
 def getDeviceXML(request):
@@ -189 +220 @@
 """
 Sets up the domain manager ip address to run based on a given POST request
+@param request The Django request parameter for views
+@return The domain string options using the -ORBInitRef and ip address using corba
 """
 def getDomainIP(request):
@@ -228 +261 @@
 @param user: The user's username with access to the node
 @param password: The user's password
+@return HttpResponse with local variables as a context dictionary inserted into the console.html template
 '''
 def nodeBooter_page(request, ip, port, user, password):
@@ -243 +277 @@
 
 """
-Connect to a node through a form
+Connect to a node through post variables
+@param request Contains the post variables floor, number, user, and pass to connect to a node
+@return The local variables as dictionary into the DomainMan/runningNodebooter.html template
+    If one of the post variables are not there, it will print a "Missing ssh connection parameters" string
 """
 def connect_to_node(request):
@@ -265 +302 @@
 """
 Raise exception if the inputs of the floor and node number are invalid
+@param floor The given floor to check
+@param num The given node number to check
+@return Exception if the floor or node num is less than 1 or greater than 4 or 12, respectively
 """
 def testValidInputs(floor, num):
@@ -273 +313 @@
 
 #@login_required
+"""
+Loads the DomainMan/nodes.html template based on a logging into a specific node
+@param floor_num The floor of the node to login to
+@param node_num The node number of the node to login to
+@return The HttpResponse object with the local variables added to the dictionary
+"""
 def loadNode(request, floor_num, node_num):
     floor = int(floor_num)
@@ -289 +335 @@
 """
 Returns connection form
+@param selectFloor The floor of the node to login to
+@param selectNum The node number of the node to login to
+@return the HttpResponse object with the local variable dictionary in the DomainMan/connect.html template
 """
 def connect_to_node_view(request, selectFloor, selectNum):
@@ -297 +346 @@
     testValidInputs(selectedFloor, selectedNum)
     return render_to_response('DomainMan/connect.html', locals(), RequestContext(request))
-
-def ajax_example(request):
-    if not request.method == 'GET':
-        name = "did not work"
-        print request.GET
-        return render_to_response('DomainMan/ajax_example.html', locals(), context_instance=RequestContext(request))
-    response_dict = {}
-    name = request.GET.get('name', False)
-    total = request.GET.get('total', False)
-    response_dict.update({'name': name, 'total': total})
-    if total:
-        try:
-            total = int(total)
-        except:
-            total = False
-    if name and total and int(total) == 10:
-        response_dict.update({'success': True })
-    else:
-        response_dict.update({'errors': {}})
-        if not name:
-            response_dict['errors'].update({'name': 'This field is required'})
-        if not total and total is not False:
-            response_dict['errors'].update({'total': 'This field is required'})
-        elif int(total) != 10:
-            response_dict['errors'].update({'total': 'Incorrect total'})
-    return render_to_response('DomainMan/ajax_example.html', response_dict, context_instance=RequestContext(request))

ossiedev/branches/jsnyder/trunk/tools/cornetApps/LoginUser/views.py

@@ -43 +43 @@
     return render_to_response("HtmlPages/account_page.html", locals(), context_instance=RequestContext(request))
 
-'''
+"""
 Redirects user to the main page.
-'''
+"""
 def logout_page(request):
         logout(request)
         return HttpResponseRedirect(url_on_web('/'))
 
-'''
+"""
 Create user account in registration page
 Checks for posting form.
-'''
+"""
 def register_page(request):
     if request.method == 'POST':

ossiedev/branches/jsnyder/trunk/tools/cornetApps/settings.py

@@ -1 @@
-
-
 # Django settings for running cornetApps project *locally*
 
@@ -15 +13 @@
     'default': {
         'ENGINE': 'django.db.backends.sqlite3', # Add 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'.
-        #'NAME': 'cornetApps.db',                      # Or path to database file if using sqlite3.
             'NAME': 'cornetApps.db',  #webserver
         'USER': '',                      # Not used with sqlite3.

ossiedev/branches/jsnyder/trunk/tools/cornetApps/settingsWeb.py

@@ -13 +13 @@
     'default': {
         'ENGINE': 'django.db.backends.sqlite3', # Add 'postgresql_psycopg2', 'postgresql', 'mysql', 'sqlite3' or 'oracle'.
-        #'NAME': 'cornetApps.db',                      # Or path to database file if using sqlite3.
-               'NAME': '/home/webdemo/cornetApps/cornetApps.db',  #webserver
+        #'NAME': 'cornetApps.db',                      # webserver
+               'NAME': '/home/webdemo/cornetApps/cornetApps.db',  #Or path to database file if using sqlite3.
         'USER': '',                      # Not used with sqlite3.
         'PASSWORD': '',                  # Not used with sqlite3.

ossiedev/branches/jsnyder/trunk/tools/cornetApps/urls.py

@@ -43 +43 @@
     url(r'^DomainMan/managers/(?P<floor>\d{1})/(?P<num>\d+)/(?P<user>.*)/(?P<password>.*)/$', 'DomainMan.views.manager_view'),
     url(r'^DomainMan/startManager/$', 'DomainMan.views.startManager'),
-    url(r'^xhr_test/$', 'DomainMan.views.xhr_test'),
-    url(r'^ajax/$', 'DomainMan.views.ajax_example'),
 
     # url(r'^cornetApps/', include('cornetApps.foo.urls')),