2009 Projekt zaliczeniowy z Inżynierii Oprogramowania Maciej Lis Katolicki Uniwersytet Lubelski Jana Pawła II 2009-01-04
Projekt zaliczeniowy z Inżynierii Oprogramowania Dokumentacja autorskiego programu NK Desktop Foto Spis treści 1 PODSTAWOWE INFORMACJE... 2 2 WYMAGANIA OGÓLNE... 2 3 DIAGRAM PRZYPADKÓW UŻYCIA... 3 3.1 DOKUMENTACJA AKTUALIZUJ ZDJĘCIA... 4 3.2 DOKUMENTACJA OTWÓRZ OPCJE... 5 4 DIAGRAMY KLAS... 6 4.1 KLASA KLIENTTCP... 6 4.2 KLASA PLIKINI... 7 4.3 KLASA TRAY... 7 5 DIAGRAM AKTYWNOŚCI... 9 6 DIAGRAM SEKWENCJI... 10 7 DIAGRAM MASZYNY STANOWEJ... 11 7.1 METODA AKTUALIZUJZDJEC... 12 7.2 METODA ZALOGUJ... 13 7.3 METODA POBIERZSTRONE... 14 7.4 METODA ZNAJDZZDJECIA... 15 7.5 METODA SCIAGNIJZDJECIA... 16 7.6 METODA KONWERTUJZDJECIA... 17 7.7 METODA UTWORZDCZEZDJECIAMI... 18 8 DIAGRAM KOLABORACJI... 19 9 PRZYKŁADOWE ZDJĘCIA Z PROGRAMU... 20 9.1 WYŚWIETLANIE OBRAZKÓW... 20 9.2 WYGLĄD MENU... 20 1
1 Podstawowe informacje Nazwa aplikacji NK Desktop Foto Imię i nazwisko autora Maciej Lis Data wykonania 2009-01-04 2 Wymagania ogólne Program wyświetla na pulpicie ostatnio dodane zdjęcia przez znajomych z portalu społecznościowego Nasza Klasa 1. Posiada możliwość automatycznej jaki i na życzenie użytkownika aktualizacji zdjęć. Dane konfiguracyjne programu zamieszczone są w pliku, a zdjęcia w odpowiednich katalogach. Główny program dodatkowo używa zewnętrznego programu do konwersji zdjęć, gdyż WINAPI obsługuje jedynie bitmapy. 3 Ręczna konfiguracja programu Aby program mógł działać właściwie należy odpowiednio skonfigurować plik konfiguracja.ini znajdujący się w głównym katalogu programu. W sekcji autoryzacja w polach login i hasło wpisać własne dane dotyczące logowania na serwerze nasza-klasa.pl. Przykład został przedstawiony niżej. [autoryzacja] login=kowalski86 haslo=tajne 1 http://nasza-klasa.pl 2
4 Diagram przypadków użycia 4:1 DIAGRAM PRZYPADKÓW UŻYCIA 3
4.1 Dokumentacja Aktualizuj zdjęcia TABELA 4-1 ZAKTUALIZUJ ZDJĘCIA - PRZYPADEK UŻYCIA Nazwa Aktualizuj zdjęcia Numer 3 Twórca Poziom ważności Typ przypadku użycia Aktorzy Maciej Lis Wysoki Niezbędny Użytkownik nasza-klasa.pl Krótki opis Zaktualizowanie ostatnio dodanych zdjęć Warunki wstępne Użytkownik uruchomił aplikacje Użytkownik zażądał aktualizacji zdjęć Automatyczna aktualizacja po upływie czasu Warunki końcowe Główny przepływ zdarzeń Wyświetlanie zdjęć na pulpicie Użytkownik uruchomił aplikacje Upłynął określony czas Alternatywny przepływ zdarzeń Użytkownik uruchomił aplikacje Alternatywny przepływ zdarzeń Użytkownik uruchomił aplikacje Użytkownik zażądał aktualizacji zdjęć Wyjątki w przepływach Jeżeli aktualizacja zostanie uruchomiona więcej niż jeden raz to zostanie wykonana raz Specjalne wymagania Notatki Brak Brak 4
4.2 Dokumentacja Otwórz opcje TABELA 4-2 OTWÓRZ OPCJE - PRZYPADEK UŻYCIA Nazwa Otwórz opcje Numer 4 Twórca Poziom ważności Maciej Lis Niski Typ przypadku użycia Zbędny dla zaawansowanych użytkowników Aktorzy Krótki opis Warunki wstępne Warunki końcowe Główny przepływ zdarzeń Użytkownik Otwiera okno w którym można wpisać opcje połączenia, login, hasło Użytkownik uruchomił aplikacje Wyświetlone zostaje okno z opcjami programu Użytkownik uruchomił aplikacje Alternatywny przepływ zdarzeń Brak Użytkownik zażądał wyświetlenia okna z opcjami Wyjątki w przepływach Specjalne wymagania Notatki Gdy trwa aktualizacja zdjęć okno pokaże się z opóźnieniem Brak Brak 5
5 Diagramy klas Wszystkie trzy klasy znajdują się w plikach o nazwach zgodnych z ich tytułami. Znajdują się w głównym katalogu programu. 5.1 Klasa KlientTcp Klasa KlientTcp realizuje w prosty sposób połączenie z dowolną maszyną. Atrybuty: gniazdo zawiera typ połączenia warstwy transportowej i sieciowej, w tym przypadku odpowiednio TCP oraz IP. Zawiera również informacje, że komunikacja będzie się odbywać za pomocą IP wersji czwartej. adres zawiera szczegółowe informację dotyczące maszyny z którą mamy się połączyć takie jak adres IP, oraz port. Metody: konstruktor, destruktor, Polacz inicjującą połączenie z danym adresem IP, Wyslij wysyłającą dane do połączonej maszyny, Odbierz zwracającą otrzymane informacje, Rozłącz kończącą połączenie. 5:1 KLIENTTCP 6
5.2 Klasa PlikIni Klasa ma za zadanie komunikowanie się programu z plikiem konfiguracyjnym typu ini. Działania te są realizowane dzięki funkcjom systemowym WINAPI. Atrybuty: nazwapliku zawierającą nazwe pliku zdeklarowaną w Metody: konstruktorze klasy. konstruktor w którym deklarujemy nazwę pliku, DajWartoscInt zwracającą wartość typu int z pliku konfiguracyjnego, DajWartoscString zwracającą wartość typu string z pliku konfiguracyjnego, WstawDane wstawiającą lub podmieniającą zmienną oraz jej wartość w pliku konfiguracyjnym. 5:2 PLIKINI 5.3 Klasa Tray Klasa odpowiada za całą otoczkę działania ikonki z zasobnika systemowego. Atrybuty: tray zawierającą dane indentyfikacyjne obiektu. Metody: konstruktor, 7
destruktor, UtworzZZasobów tworzy ikonkę tray na podstawie zasobów zdeklarowanych w pliku rs, UtworyZeSciezki tworzy ikonkę tray na podstawie ścieżki do pliku ico, ZmienPodpowiedz zmienia podpowiedz wyświetlającą się po najechaniu kursorem na ikonkę, ZmienIkonkeZasoby zmienia ikonkę tray na podstawie zasobów zdeklarowanych w pliku rs, ZmienIkonkeSciezka zmienia ikonkę tray na podstawie ścieżki do pliku ico, Usun usuwa ikonkę z zasobnika systemowego, PokazMenu wstawiającą lub podmieniającą zmienną oraz jej wartość w pliku konfiguracyjnym. 5:3 TRAY 8
6 Diagram aktywności Diagram opisuje w skrócie działanie programu, oraz komunikacje z serwerem nasza-klasa.pl. 6:1KOMUNIKOWANIE SIĘ PROGRAMU 9
7 Diagram sekwencji Diagram opisuje jak wygląda komunikacja między serwerem a klientem względem czasu. Jak widać znacznie więcej czasu zajmuje pobieranie zdjęć ze strony naszej-klasy, niż przesłanie zwykłych komunikatów do serwera. 7:1 DIAGRAM SEKWENCJI 10
8 Diagram maszyny stanowej Diagram opisuje ogólne działanie programu od strony programistycznej. 8:1DIAGRAM STANÓW 11
8.1 Metoda AktualizujZdjec TABELA 8-1 AKTUALIZACJA ZDJĘĆ Nazwa funkcji AktualizujZdjec Krótki opis Parametry Zwracana wartość Dodatkowe wyniki Wykonalność Algorytm Dodatkowe zależności Metoda aktualizuje zdjęcia. Brak (void) Brak (void) Brak Gdy istnieje plik konfiguracyjny, oraz wszystkie metody z których korzysta przebiegną pomyślnie 1. Zmień ikonę tray na aktualizacje 2. Sprawdź czy plik konfiguracyjny istnieje 3. Pobierz login i hasło z pliku 4. Wykonaj metody w kolejności jw. 5. Zmień ikonę tray na normalną pracę Korzysta z 6 metod: Zaloguj() PobierzStrone() ZnajdzZdjecia() SciagnijZdjecia() KonwerujZdjecia() UtworzDCZeZdjeciami() 12
8.2 Metoda Zaloguj TABELA 8-2 LOGOWANIE NA SERWER Nazwa funkcji Krótki opis Zaloguj Loguje na serwer jednocześnie zapisując dane sesji cookies Parametry login : string haslo : string Zwracana wartość Dodatkowe wyniki Wykonalność Algorytm Dodatkowe zależności cookies : string Brak Gdy połączenie z serwerami nasza-klasa.pl będzie możliwe, oraz w wyniku zapytania będzie blok cookies 1. Połącz z serwerem naszej klasy 2. Wyślij zapytanie z blokiem typu POST zawierającym login i hasło 3. Odbierz odpowiedz serwera 4. Wytnij z odpowiedzi blok cookies 5. Zwróć cookies Korzysta z klasy KlientTcp 13
8.3 Metoda PobierzStrone TABELA 8-3 POBRANIE STRONY PROFILOWEJ Nazwa funkcji PobierzStrone Krótki opis Loguje na serwer jednocześnie zapisując dane sesji cookies Parametry login : string haslo : string Zwracana wartość Dodatkowe wyniki Wykonalność Algorytm Dodatkowe zależności cookies : string Brak Gdy połączenie z serwerami nasza-klasa.pl będzie możliwe, oraz w wyniku zapytania będzie blok cookies 1. Połącz z serwerem naszej klasy 2. Wyślij zapytanie z blokiem typu POST zawierającym login i hasło 3. Odbierz odpowiedz serwera 4. Wytnij z odpowiedzi blok cookies 5. Zwróć Cookiem Korzysta z klasy KlientTcp 14
8.4 Metoda ZnajdzZdjecia TABELA 8-4 WYSZUKIWANIE ZDJĘĆ Nazwa funkcji ZnajdzZdjecia Krótki opis Wyszukuje linki do zdjęć w kodzie strony i zapisuje je do tablicy Parametry strzezdj : string urlzdj : string [8] Zwracana wartość Dodatkowe wyniki Wykonalność Brak (void) Tablica urlzdj z adresami url do zdjęć Gdy strzezdj zawiera ciąg znaków dodane ostatnio przez Twoich znajomych Algorytm 1. Znajdz ciąg znaków dodane ostatnio przez Twoich znajomych na stronie 2. Znajdź zdjęcia 3. Zapisz zdjęcia do tablicy Dodatkowe zależności Brak 15
8.5 Metoda SciagnijZdjecia TABELA 8-5 POBRANIE ZDJĘĆ Nazwa funkcji SciagnijZdjecia Krótki opis Ściąga zdjęcia do katalogu z programem Parametry urlzdj : string [8] nazzdjjpeg : string [8] Zwracana wartość Dodatkowe wyniki Wykonalność Algorytm Dodatkowe zależności Brak (void) Tablica nazzdjjpeg ze ścieżkami dostępu do zdjęć w formacie jpeg Gdy połączenie z serwerami nasza-klasa.pl będzie możliwe, oraz pliki ze zdjęciami istnieją 1. Ściągnij kolejne zdjęcie 2. Odetnij niepotrzebne nagłówki 3. Zapisz je w katalogu głównym programu 4. Powtórz aż zostaną ściągnięte wszystkie zdjęcia z tabeli urlzdj Korzysta z klasy KlientTcp 16
8.6 Metoda KonwertujZdjecia TABELA 8-6 KONWERSJA ZDJĘĆ Nazwa funkcji KonwertujZdjecia Krótki opis Konwertuje zdjęcia z formatu jpeg do standardu bmp Parametry nazzdjjpeg : string [8] nazzdjbmp : string [8] Zwracana wartość Dodatkowe wyniki Brak (void) Tablica nazzdjbmp ze ścieżkami dostępu do zdjęć w formacie bmp Wykonalność Gdy istnieje zewnętrzny program jpeg2bmp.exe, oraz ścieżki do zdjęć nazzdjjpeg są poprawne Algorytm 1. Sprawdź czy istnieje program jpeg2bmp.exe 2. Sprawdź czy istnieje zdjęcie 3. Konwertuj zdjęcie 4. Powtórz aż zostaną skonwertowane wszystkie zdjęcia z tabeli nazzdjjpeg Dodatkowe zależności Program jpeg2bmp.exe 17
8.7 Metoda UtworzDCZeZdjeciami TABELA 8-7 UTWORZENIE KONTEKSTU URZĄDZENIA Nazwa funkcji UtworzDCZeZdjeciami Krótki opis Tworzy kontekst urządzenia na podstawie zdjęć Parametry nazzdjbmp : string [8] Zwracana wartość Dodatkowe wyniki Wykonalność Algorytm Dodatkowe zależności Brak (void) hdccal zawiera wkomponowane zdjęcia Gdy ścieżki dostępu do zdjęć w tabeli nazzdjjpeg są poprawne 1. Wyczyść kontekst urządzenia hdccal 2. Wkomponowuje kolejne zdjęcia do hdccal Brak 18
9 Diagram kolaboracji Podczas potrzeby konwersji zdjęcia wywoływany jest program zewnętrzny jpeg2bmp.exe. Zmienia on format zdjęcia z kompresji jpeg na standard bmp. Wymagane jest to, gdyż system WINAPI pozwala wyświetlać jedynie bitmapy. 9:1 DIAGRAM KOLABORACJI MIĘDZY PROGRAMAMI 19
10 Przykładowe zdjęcia z programu 10.1 Wyświetlanie obrazków 10:1 WYŚWIETLANIE ZDJĘĆ 10.2 Wygląd menu 10:2 WYGLĄD MENU 20