gitar

============

Since web apps (and everything web related) are known to suck at dependency handling (which is why we have Bower, NPM, cdnjs, docker, ... (I'll explain sometime somewhere why this is done, and why I don't like it), I've decided to take matters in my own hands; I'll just provide one simple markdown file listing all dependencies in human-readable format. I don't care whether this helps or not, but no harm is done, right?

Legend

------

The dependencies themselves have been ranked with a certain grade. I explain what they mean here:

 * A : This dependency is present inside the app. This will be in the form of ready-to-use source code files. As such, they need no further attention.

 * B : This dependency is present inside the app. This will be in the form of an archive file (i.e. .tar.gz), OR this needs additional work to function properly. In these cases, I refer to their documentation which will be available at the location of the files.

 * C : This dependency does not come with the app. These are often system packages, which often means (if you're on GNU/Linux) you'll have to search for it in your repositories. Their documentation is your last resort for these if it doesn't work as it should.

I hope I never will, but when it's necessary, I'll add a D grade, for unreadable, egregious bogus software that will give you all horrible kinds of diseases if you dare to work with it, but are indispensable to make the web app function. Just be happy I don't use it yet. (For example, PHP qualifies as D, so praise [our lord and saviour](https://rms.sexy) I write Python.)

A

-

B

-

C

-

 * [GitPython](https://github.com/gitpython-developers/GitPython): Provides a

   wrapper to ease Git interaction from Python.

 * [PostgreSQL](https://postgresql.org): PostgreSQL is (currently) the only

   supported database.

    Copyright © 2016 Maarten "Vngngdn" Vangeneugden

    This program is free software: you can redistribute it and/or modify

    it under the terms of the GNU Affero General Public License as

    published by the Free Software Foundation, either version 3 of the

    License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,

    but WITHOUT ANY WARRANTY; without even the implied warranty of

    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License

    along with this program. If not, see https://www.gnu.org/licenses/agpl.html.

"""

from django.shortcuts import get_object_or_404, render  # This allows to render the template with the view here. It's pretty cool and important.

from django.http import HttpResponseRedirect, HttpResponse 

from django.core.urlresolvers import reverse 

from .models import *

from .GitActions import RepoInfo

from git import Repo  # GitPython functionality.

import git

# First, I list some standard variables that are common for most of the sites of this app.

def footer_description():

    return "Gitar is a simple web app that allows its users to easily share Git repos in combination with the Django framework."

def footer_links():

    footer_links = [

            ['Source', 'OHGODHELPNOTDONEYET'],

            ['Personal website', reverse('about-index')],

            ]

    return footer_links

def standard_context():

    context = {

            'materialDesign_color': "blue-grey",

            'materialDesign_accentColor': "green",

            'navbar_title': "Gitar",

            'navbar_backArrow': False,

            'footer_title': "Gitar",

            'footer_description': footer_description(),

            'footer_links': footer_links(),

            }

    return context

# From here, the actual views start.

def index(request):

    """ The start page of Gitar.

    The goal of this view, is to collect all the available repositories,

    including some additional information, such as programming language,

    license, description, ... in order to give a fast overview of the most

    prominent information.

    """

    # Collecting the available repositories:

    # Template:

    template = "gitar/index.html"

    # Requesting the repositories:

    modelRepos = Repository.objects.all()

    # From here, we start collecting info about all the repositories:

    class BlankRepository: pass  # Blank object in which all data will be collected.

    repositories = []

    for modelRepo in modelRepos:

        repository = BlankRepository()

        # TODO: Find a way to add all of modelRepo's fields without having to

        # hardcode them. This is prone to errors and is redundant.

        repository.name = str(modelRepo)

        repository.programmingLanguage = modelRepo.programmingLanguage

        repository.license = modelRepo.license

        repository.description = RepoInfo.get_description(modelRepo)

        #gitRepo = Repo.init(modelRepo.directory(), bare=True)  # Connects to the Git Repo.

        # See tests.py, which assures all repositories exist. Tests are handy.

        #repository.description = gitRepo.description

        # This is mostly personal taste, but I like to show the amount of files.

        #repoTree = gitRepo.heads.master.commit.tree

        #repository.fileCount = len(repoTree.blobs)  # blobs are files.

        repositories.append(repository)

    # After that, I extend the standard context with the repositories:

    context = standard_context()

    context['repositories'] = repositories

    # And finally, sending everything back.

    return render(request, template, context)

def repositories(request, repositoryName):

    # I first form the repository link out the given name.

    # TODO: Form repo link out of given name.

    assert repository.bare  # My own repos are always bare.

    content = repository.heads.master.commit.tree

    # Out of which I can deduce the files:

    files = content.blobs

    fileNames = []

    for filee in files:

        fileNames.append(filee.name)

    template = "gitar/repositories.html"

    context = standard_context()

    context['files'] = fileNames

    assert len(content.blobs) > 0

    assert len(fileNames) > 0

    return render(request, template, context)

def path_explorer(request, repository_name, path):

    """ Checks whether the given path is a file or a directory, and calls the

    appropriate view function accordingly.

    """

    repository = RepoInfo.get_repository_object(repository_name)

    # From the GitPython documentation:

    # You can obtain the tree object of a repository, which is the directory of

    # that repo. This tree can be accessed as if it were a native Python list,

    # where the elements are the subdirectories and files. So, the idea to

    # determine whether a file, or a directory was requested, is simple:

    # 1. Split the path with "/" as seperator.

    # 2. Replace the current tree variable with the one retrieved from the

    # subtree element

    # 3. Repeat 2. until all parts of the given path are exhausted.

    # If we now still have a tree, we're looking at a directory, so display the

    # files (and subdirectories) of this directory.

    # Else, if we hit a blob, display the file contents.

    path_parts = path.split(sep="/")

    # FIXME: If the user gives a "<something>/../<somethingElse>", that should

    # become "<something>". Obviously, although I think that's done by default

    # already.

    directory = repository.heads.master.commit.tree

    for i in range(len(path_parts)):

        subdirectories = directory.trees

        if len(subdirectories) == 0:

            # If there's no more subdirectory, and we get here, then that means

            # it's a file for sure, because otherwise, the iterator would've

            # stopped.

            file_blob = directory.blobs[path_parts[i]]

            return file_viewer(request, repository_name, file_blob)

        else:

            directory = subdirectories[path_parts[i]]

    # Current state:

    # The entire path was traversed, and we kept reaching subdirectories, which

    # means that the current directory was requested, and not a file. Thus,

    # display the directory.

    return directory_view(request, repository_name, directory)

def directory_view(request, repository_name, path, directory):

    """ Collects the given directories's files and subdirectories, and renders a

    template to display this data.

    """

def file_viewer(request, repository_name, path, ffile):

    """ Collects the file contents of the given file path, and returns it to the

    template, with the file contents already formatted in HTML using Pygments.

    """