nuno-silva/es16al_35-project

Project for the Software Engineering Course, IST, 2016

Hi there 👋

I'm Nuno Silva, former SysAdmin at IST.

All the statistics

NOTE: "Most Used Languages" does not indicate my skill level or anything like that. It's a GitHub metric of which languages have the most code on GitHub.

es16al_35-project's Issues

Fix Build

34d10c3 broke the build

Import and export XML

Create methods to import and export XML file

Implement User

Implement Link instantiation from XML import

FileSystem constructor does not throw InvalidUsernameException

Create method: createSuperUser()

Implement FileSystem XML export visitor

Remove a file

Removes a file or an empty directory based on its path.

Requires #7

Implement File deletion from Directory

Support deleting a file from a directory.

While analysing this, I found that File does not need the isDeleted attribute. File deletion is handled using a File.remove() method, which removes it from it's parent Directory.

See Contact.java for an example (Contact is a File and Person is a Directory).

needed for #8
will affect #7

Add visitor pattern to all exportable classes

Implement the visitor pattern (which will be used in XML exports) to all the classes that can be exported.

Implement file insertion in directories

This is basically (but not only) the Directory.addFile() method.

Person.java has an example on how to do this.

needed for #8

Exceptions

Self-explanatory exceptions for each error situation.

Implement FileSystem

Implement Links

Dml change again(class File)

Class file needed an extra attribute, something to verify if it was deleted, since java doesn't have delete but instead uses a garbage collector.

Update on DML

On our DML we initially had the follow relation

relation DirectoryHasFiles {
    Directory playsRole directory { multiplicity 1; }
    File playsRole file { multiplicity 2..*; }
}

However if we wish it to run properly we need to create at least 2 files(supposedly it would be . and ..) but we wont have a copy of himself(.) in the database.
We should also discuss if we need the .. or if it's useless.

Should be solved before #23 is even thought about.

Implement App

Convert permission bytes to "human readable" format

We need to convert the 0's and 1's to a "human-readable format" (like rwxrwxr-x). I suggest adding a method to User (something like .getHRPermissions()) that takes care of that.

Implement Manager

Directory Listing

Lists the files on a directory based on its path

Requires #8 and #7

Implement Link XML export visitor

Implement Directory instantiation from XML import

Implement PlainFile instantiation from XML import

Implement fileSystem constructor

Creates rootDir
Creates Super User
Creates Super User home directory

Decide on whether to implement filesystem manager class

Advantages:

1. Relieve fileSystem class from the job of having to read and print the XML file (Manager would read the XML and call method from filesystem class to actually import it, thus updating new users)
2. Separate domainRoot (fileSystem setup) from fileSystem functionality

Once debated between the group, implement the solution agreed upon.

Directories can only be removed when empty

introduced in #8 and #49

Currently, we are removing everything from the Directory if it's not empty.

Implement user constructor

Implement InvalidUsernameException in case username is unacceptable

Implement exceptions

Create and handle exceptions in the code.

Type of home directory

What data type should we choose for a user's home director?

• String attribute
• relation with User
• none (it can be obtained from the username)
  #3 depends on this.

Filesystem Identification

The current dml does not allow to identify a specific FileSystem. It needs some sort of identification.

Implement User XML export visitor

Implement App XML export visitor

Implement App instantiation from XML import

Implement User instantiation from XML import

change UML to .jpg or .pdf

just so we dont forget

Project doesn't compile

Project doesn't compile due to class File in dml.
`class File{

String fileName;
User owner;  <------- error here
long id;
byte perm;
DateTime lastMod;

}`

Configure database for FenixFramework

• database name: drivedb
• database user: mydrive
• datebase password: mydriv3

Implement Singleton in Manager

Implement the Singleton pattern in Manager class.

Consistency in Users and Directories

Regarding the "users without home directories" and "directories/files without an owner" issues mentioned by the teacher, how should we tackle them?

I suggest to take an event-driven approach. What I mean by that is when a user or a directory/file is created, it will notify some central entity, for example the Manager or the FileSystem (or even a separate entity), which will make sure that everything is okay(i.e that the user has a home directory and that the directory/file has an owner). If something is not okay, that entity is responsible for correcting the problem, making sure that the business rules are not violated (for example, defaulting the owner of directories/files without an owner to root).

The idea is to centralize the business rules in a single place, that will make making changes to them easier in the future (if necessary).

Wiki for the 1st sprint

According to es16p1.pdf, the wiki for the first sprint should be finished, in our case, before the lab on 2016/03/07.

The wiki should contain:

• specification of each story
• story assignments for each team member, including the sprint-1 milestone
• listing of the team members, including each member's first and last name, ISTid and GitHub username

See section 6 of guialab.pdf.

Implement Directory

needed for #14

Implement Directory XML export visitor

Implement PlainFile

Implement FileSystem instantiation from XML import

Add functionality to import a FileSystem from XML.

Implement File

Template For Contributions

Choose a template for commit messages.

FileSystem Constructor

When working on the FileSystem's constructor I found what I think might be a problem... Are we gonna leave the home directory for the users (/home/username/) as a String or are we going to insert a new Directory in /home/ where the new directories name is the username?

Check username

Check consistency in usernames provided, they must be:

1. not empty
2. exclusively made up of characters and digits

DML

We need to reveal our dml's and come up with the best solution.

Implement PlainFile XML export visitor

Read a file content

Reads the content of a file based on a given path.

Requires #10 and #7