[[Category:OPS435-Python]][[Category:rchan]]
<font color='red'>'''DRAFT - Under Construction'''</font>=Assignment 1 - Users' Usage Report='''Weight:''' 2015% of the overall grade
'''Due Date:''' Ask your professor for exact date
==Overview==
Most system administrators would like to know the utilization of their systems by their users. On a Linux system, the userseach user' s login records are normally stored in the binary file /var/log/wtmp. The login records record in this binary file can not be viewed or edited directly using normal Linux text commands like 'less', 'cat', etc. The 'last' command is often used to display the login records stored in this file in a human readable form. Please check the man page of the 'last' command for available options. The following listing is a sample output of running the 'last' commandwith the '-F' flag on:
<pre>
$ last -F
</pre>
In this assignment, your task is to create a python program with well designed functions to produce daily, weekly, and monthly usage report reports by user or by remote host based on the information obtained from the 'last' command or given files which contain similar information as the 'last' command.
== Resource for useful modules ==
* the <b>argparse</b> module
** [https://docs.python.org/3/howto/argparse.html Argparse Tutorial] - should read this first.
** [https://docs.python.org/3/library/argparse.html Argparse API reference information page]
* the <b>time</b> module
** [https://www.tutorialspoint.com/python3/python_date_time.htm Time module Tutorial]
** [https://docs.python.org/3/library/time.html Time module API reference page]
== Instructions ==
=== Program Name and valid command line arguments ===
Name your Python3 program as <code>usage_reportur.py</code>. The program should accept zero one or more "file name" as its command line parametersand other optional parameters as shown below. Your ur.py script should produce the following usage when run with the --help option:* <bpre><code>filename<[rchan@centos7 a1]$ python3 ./code></b>ur.py -husage: ur.py [-h] [-l {user,host}] [-r RHOST] [-t {daily,weekly, ormonthly}] [-u USER] [-v]* <b><code>filename1 filename2 </code></b> etc F [F ... ] Usage Report based on the last command positional arguments: F list of files to be processed optional arguments: -h, --help show this help message and exit -l {user,host}, --list {user,host} generate user name or remote host IP from the given files -r RHOST, --rhost RHOST usage report for the given remote host IP -t {daily,weekly,monthly}, -- any number type {daily,weekly,monthly} type of filenames from 1 to as many as report: daily, weekly, and monthly -u USER, --user USER usage report for the commandgiven user name -v, --verbose tune on output verbosity Copyright 2018 -Raymond Chan </pre>Replace the last line supports.with your own full name
If there one of the file name given is no command line argument"last", your python program should get the login records from the 'last' command with the appropriate flags.
If there is one filename file name provided at the command line, gets read the login records from the contents of the given file. The format of the lines each line in the file should be the same as the output of 'last -FFiw'.
If there is more than one filename file name provided, merges all the files together with the first one at the top and the last one at the bottom. Read and process the file contents in that order in your program.
=== Header ===
All your Python codes for this program must be placed in a <font color='red'><b><u>single source file</u></b></font>. Please include the following declaration by <b><u>you </u></b> as comment in your Python source code file (replace "Student Name" with your own name):
<source>OPS435 Assignment 1 - Winter Summer 2018Program: usage_reportur.py
Author: "Student Name"
The python code in this file (usage_reportur.py) is original work written by
"Student Name". No code in this file is copied from any other source
including any person, textbook, or on-line resource. I have not shared
</source>
=== Main Menu ===
When your Python program is running, it should present the user with the following menus:
<source>Reading login records... Done. Usage Report - Main Menu========================d) Daily Usage Reportw) Weekly Usage Reportm) Monthly Usage Reportq) Quit</source> Option <b>d</b>, <b>w</b>, and <b>m</b> when selected will display a new sub-menu. When option <b>q</b> is selected, you program should terminate. by User === Daily Usage Menu ===* If the Daily Usage Report option The following is selected from the Main Menu, the following sub-menu should be presented on the screen: <source>a sample Daily Usage Report Menu=======================u) By Userh) By Remote Hostr) Return to Main Menu</source> When option <b>u</b> is selected, the sub-menu for Daily Usage Report by User should be displayeduser1 on host. When option <b>h</b> is selected, the sub-menu for Daily Usage Report by Remote Host should be displayedcty. When option <b>r</b> is selected, the main menu should be displayedsenecacollege.ca:<sourcepre>Daily Usage Report - by Userfor user1
============================
...Date Usage in secondsDisplay list of valid user2018 02 14 60...2018 02 07 45r) Return to Daily Usage Report Menu</source>When a <b>valid user</b> is selected, display the Daily Usage Report for the selected user.2018 02 01 5
<b>Valid userTotal 110</bpre> is regular user (super user and system users should not be included) who are allowed to login to the system.
When option <b>r</b> ==== Daily Usage Report by Remote Host====The following is selected, the a sample Daily Usage Report menu should be displayedfrom Remote Host 10.94.10.25 on host.cty.senecacollege.ca:
<sourcepre>Daily Usage Report - by Remote Hostfrom 10.94.10.25
===================================
...Date Usage in secondsDisplay list of valid Remote Host2018 02 14 30...r) Return to Daily Usage Report Menu2018 02 07 41</source>2018 02 01 9
When a <b>valid Remote HostTotal 80</bpre> is selected, display the Daily Usage Report for the selected Remote Host.
<b>Valid Remote Host</b> ==== Weekly Usage Report by User ====The following is any a sample Weekly Usage Report for user1 on host that any <b>valid user</b> used to login to the system.cty.senecacollege.ca:
When option <bpre>r</b> is selected, the Daily Usage Report menu should be displayed. === Weekly Usage Menu ===* If the Weekly Usage Report option is selected from the Main Menu, the following sub-menu should be presented on the screen: <source>Weekly Usage Report Menu========================u) By Userh) By Remote Hostr) Return to Main Menu</source> When option <b>u</b> is selected, the sub-menu for Weekly Usage Report by User should be displayed. When option <b>h</b> is selected, the sub-menu for Weekly Usage Report by Remote Host should be displayed. When option <b>r</b> is selected, the main menu should be displayed. <source>Weekly Usage Report - by Useruser1
=============================
...Display list of valid userWeek # Usage in Seconds...2017 01 160r) Return to Weekly Usage Report Menu2017 02 45</source>2017 03 5When a <b>valid user</b> is selected, display the Weekly Usage Report for the selected user.2017 04 20
When option <b>rTotal 220</bpre> is selected, the Weekly Usage Report menu should be displayed.
<source>==== Weekly Usage Report - by Remote Host===================================The following is a sample Weekly Usage Report from the remote host 10.94.10.Display list of valid Remote Host25 on host.cty.senecacollege.r) Return to Weekly Usage Report Menu</source>ca:
When a <bpre>valid Remote Host</b> is selected, display the Weekly Usage Report for the selected Remote Hostfrom 10.94.10.25====================================Week # Usage in Seconds2017 01 302017 03 412017 05 92017 06 11
Total 91
</pre>
When option <b>r==== Monthly Usage Report by User ====The following is a sample Monthly Usage Report for user1 on host.cty.senecacollege.ca:</bpre> is selected, the Weekly Monthly Usage Report menu should be displayed.for user1==============================Month Usage in Seconds2017 01 1602017 02 45
=== Monthly Usage Menu ===Total 205* If the Monthly Usage Report option is selected from the Main Menu, the following sub-menu should be presented on the screen:</pre>
<source>Monthly Usage Report Menu=====================Monthly Usage Report by Remote Host ====u) By Userh) By Remote Hostr) Return to Main Menu</source>The following is a sample Monthly Usage Report for 10.94.10.25 on host.cty.senecacollege.ca:
When option <bpre>u</b> is selected, the sub-menu for Monthly Usage Report by User should be displayedfrom 10.94.10.25=====================================Month Usage in Seconds2017 01 302017 02 41
When option <b>hTotal 71</bpre> is selected, the sub-menu for Monthly Usage Report by Remote Host should be displayed.
When option <b>r</b> == Program Development and Testing ==You should create python functions to handle the following sub-tasks:* gets login records from the output of "last" command and filters out unwanted records* reads login records from files and filters out unwanted records* generate daily usage reports by user or by remote host* generate weekly usage reports by user or by remote host* generate monthly usage reports by user or by remote hostTo help you with this assignment, [[OPS435 A1 Usage Report Template|here is selected, the main menu should be displayeda template]] you can use as a starting point in developing your Python Usage Report program.
<source>Monthly Usage Report - by User==============================...Display list of valid user...r) Return to Monthly Usage Report Menu</source>When Once you have finished coding a <b>valid user</b> is selectedfunction, display the Weekly Usage Report for the selected user. When option <b>r</b> is selectedyou should start a Python3 interactive shell, import your functions and manually call the Weekly Usage Report menu should be displayedfunction you want to test.
<source>Monthly Usage Report - Once you have all the individual function tested and that each is working properly, perform the final test with test data provided by Remote Host=====================================your professor and verify that your program produces the correct results before submitting your python program on Blackboard...Display list of valid Remote Host...r) Return to Monthly Usage Report Menu</source>
When a <b>valid Remote Host<== Sample login records file and sample run ==* [https:/b> is selected, display the Monthly Usage Report for the selected Remote Host/scs.senecac.on.ca/~raymond.chan/ops435/a1/ Sample test date files and sample runs]
== Rubric ==
When option <b>r</b> is selected, the {| class="wikitable" border="1"! Task !! Maximum mark !! Actual mark|-| Program Authorship Declaration ||1 |||-| Program usage || 2 |||-| Program Options || 2 |||-| Daily Usage Report by User || 2 |||-| Daily Usage Report by Remote Host || 2 |||-| Weekly Usage Report by User || 2 |||-| Weekly Usage Report by Remote Host || 2 |||-| Monthly Usage Report by User || 2 |||-| Monthly Usage Report menu should be displayed.by Remote Host || 2 |||-| Get Login Records from 'last' || 2 |||-| Get Login Records from files || 2 |||-| Generate user name list || 2 |||-| Generate remote host IP list|| 2 || |-| '''Total''' || 25 ||
== Sample login records file ==|}
== Submission ==
After fully testing your program, submit the your ur.py file on Blackboard