root/protocols/protocol_dummy.py

#!/usr/bin/python
# -*- coding: utf-8 -*-
import gtk
import gobject
from bug import bug
# You have to change this if you have another storage
from auth_dummy import user

class protocol:

# Available informations for authentification are :
# -  user.login()  -> string that contains the login
# -  user.password() -> string that contains the password

################INFORMATION ABOUT THE BTS ################################

        # Send back the name of the protocol as a simple string

        def Name(self):
                return "dummy"

################BUG RETRIEVING IN THE BTS #################################
        
        # Functions related to bugs in your BTS
        # Functions return an object "bug" (see bug.py)
        #
        # You have to implement the following functions :
        # - retrieveBug(int)

        def retrieveBug(self,nbr):
                zebug = bug(nbr)
                #%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
                # this is what you want to modify to support your own protocol
                zebug.setTitle("Microsoft has a majority market share")
                zebug.setDescription("Microsoft has a majority market share in the new desktop PC marketplace. This is a bug, which Ubuntu is designed to fix.\
Microsoft has a majority market share | Non-free software is holding back innovation in the IT industry, restricting access to IT to a small part of the world's population and limiting the ability of software developers to reach their full potential, globally. This bug is widely evident in the PC industry.\
Steps to repeat:\n  1. Visit a local PC store.\n What happens:\n   2. Observe that a majority of PC's for sale have non-free software pre-installed\n 3. Observe very few PC's with Ubuntu and free software pre-installed\n What should happen:\n  1. A majority of the PC's for sale should include only free software like Ubuntu\n  2. Ubuntu should be marketed in a way such that its amazing features and benefits would be apparent and known by all.\n  3. The system shall become more and more user friendly as time passes.")
                #%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
                return zebug    





################SEARCH IN THE BTS #################################

        # The functions Search will perform a search
        # in the BTS
        # All results matching the search are added to a
        # gtk.ListStore with attributes in the following orders :
        # gobject.TYPE_INT : number of the bug
        # gobject.TYPE_STRING : package
        # gobject.TYPE_STRING : title of the bug
        # gobject.TYPE_STRING : importance
        # gobject.TYPE_STRING : status
        #
        # You have to implement the following search methods for your BTS :
        # - genericSearch(string)
        # - packageSearch(string,string)
        # - advancedSearch
        # - packageExist(string) (return a boolean, not a listStore)


        #private function to create a new result gtk.ListStore
        def __newResult(self) :
                return gtk.ListStore(gobject.TYPE_INT, gobject.TYPE_STRING, gobject.TYPE_STRING, gobject.TYPE_STRING, gobject.TYPE_STRING)

        
        # genericSearch on a given string search_str.
        def genericSearch(self, search_str) :
                #creating an empty result first
                results= self.__newResult()
                #%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
                # this is what you want to modify to support your own protocol
                #inserting dummies bugs
                results.insert_before(None, [1, "Rhythmbox", search_str, "medium", "fixed"])
                results.insert_before(None, [2, "gnome-panel", search_str, "low", "unconfirmed"])
                results.insert_before(None, [3, "xterm", search_str, "urgent", "working"])
                results.insert_before(None, [4, "ubuntu", search_str, "wontfix", "commited"])
                results.insert_before(None, [5, "nautilus", search_str, "don't care", "confirmed"])
                #%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
                #returning the results
                return results

        # search on a given string search_str but only in bugs of 
        # a given package
        def packageSearch(self, package, search_str):
                #creating an empty result first
                results= self.__newResult()
                #%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
                # this is what you want to modify to support your own protocol
                #inserting dummies bugs
                if package == "evolution":
                        results.insert_before(None, [1, "evolution", "search_str", "medium", "fixed"])
                        results.insert_before(None, [2, "evolution", "search_str", "low", "unconfirmed"])
                        results.insert_before(None, [3, "evolution", "search_str", "urgent", "working"])
                        results.insert_before(None, [4, "evolution", "search_str", "wontfix", "commited"])
                        results.insert_before(None, [5, "evolution", "search_str", "don't care", "confirmed"])
                else :
                        results.insert_before(None, [0, "No package of that name", "", "", ""])
                #%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
                #returning the results
                return results

        
        # Return true is the package exist in the BTS, false if not             
        def packageExist(self, package):
                #%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
                # this is what you want to modify to support your own protocol
                return package == "evolution"
                #%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%