Minulý příspěvek popisoval jednoduchou konzolovou aplikaci, která z údajů ze sešitu programu Excel udělá PDF dokument s kartičkami. Takový dokument pak stačilo jen vytisknout, rozstříhat či rozřezat a papírové kartičky byly hotové.
Tento příspěvek popíše, jak tuto aplikaci upravit tak, že:

umožní načítat z libovolného zdroje dat (například místo Excel z CSV souboru)
zdrojový kód bude přístupný v aktuální podobě každému a nemusí se přidávat jako příloha ke stažení
aplikace bude dostupná přes webové stránky – tedy pošleme soubor a obdržíme zpět PDF dokument

A proč nadpis “Vzhůru do oblak!”? – výsledný web bude v cloudu. To je dnes takové moderní slovo – v prostředí .NET nejčastěji spojované s Azure. Ale Azure nepoužijeme – Microsoft sice nabízí trial verze, jenže ani u nich není zaručeno, že na konci za to nebude platit (zde si neodpustím poznámku, že MS na Azure a WP7 předvádí jak velká firma není schopna správných rozhodnutí a nechápe, co je pro masivnější používání daných produktů klíčové – ale to je jen můj povzdech a soukromý názor). Takže místo Azure použijeme služeb AppHarbor.

Aktualizace 18.12 17:00 – jak jsem se dočetl zde, MS konečně umožnil bezplatné zkoušení. I tak je krok za AppHarbor.

Úprava stávající aplikace

Nejprve změníme typ z konzolové aplikace na knihovnu. To je jednoduchá změna, klikneme pravým tlačítkem na název projektu a ve vlastnostech změním typ:

Nyní se musí upravit samotná aplikace. Nejprve upravíme načítání dat – nyní je v kódu napevno zakodóváno načítání přes ADO.NET z Excel souboru:

Stávající kód

void ReadAndPrintExcelSheet(...)
        {
            ...
            Action<DbCommand> read = (command) =>
            {
                command.CommandText = "SELECT * FROM [Sheet1$]";
 
                using (DbDataReader reader = command.ExecuteReader())
                {
                    ...
                    while (reader.Read())
                    {
                        ....
                    }
                }
                ...
            };
 
            Db.Work("Excel", read);
        }

Tohoto provázání se zbavíme poměrně snadno – zavedeme tento interface ICardData:

public interface ICardData

{

    string Word { get; }

    string Pronunciation { get; }

    string Example { get;  }

    string Meaning { get;  }

    string ExampleTranslation { get; }

}

Do definice třídy pro generování PDF pak přidáme delegáta Func<IEnumerable<ICardData>>, který bude ukazovat na metodu, která bude schopna poskytnout údaje o kartičkách – přičemž nyní naší třídy pro generování PDF už nebude zajímat, jak to tato metoda dělá (tedy jestli čte databázi, CSV soubor, google dokument atd.):

Upravený kód

Func<IEnumerable<ICardData>> getCardData;
...
void ReadAndPrintExcelSheet(...)
{
    ...
 
    foreach (var cardData in getCardData())
    {
        ....
    }
 
    ...
}

Pokud porovnáte nový a předešlý kód navzájem, došlo ke zjednodušení. Dle mého názoru je kód i přehlednější. Zbývá ještě udělat metodu pro delegáta getCardData :-).

Poznámka pro ICardData"

Interface ICardData je implementován abstraktní třídou CardData – tato abstraktní třída pak slouží jako předek pro třídy navázané na konkrétní zdroje dat (bude ukázáno dále):

public abstract class CardData: ICardData
{
    public string Word { get; protected set; }
    public string Pronunciation { get; protected set; }
    public string Example { get; protected  set; }
    public string Meaning { get; protected set; }
    public string ExampleTranslation { get; protected set; }
}

V zdrojovém kódu je implementována i původní podpora pro čtení Excel souborů – ale tento kód není využit (budou se zpracovávat jen CSV soubory). Slouží tedy spíše jako ukázka, jak implementovat podporu dalších zdrojů údajů o kartičkách. Jedná se o třídy DbCardDataProvider.cs, DbDataReaderCardData.cs a Database.cs.

Čteme CSV soubor

Pro čtení CSV souboru jsem si “vypůjčil” kód od Janathana Wooda. Provedl jsem jen pár úprav – zajímá mne jen čtení ze streamu, místo čárky jsem jako oddělovač definoval středník. Výsledek je v souboru CsvStreamReader.cs.
Kód této třídy je jednoduchý – umí vzít vstupní stream a postupně jej číst “po řádcích”, přičemž každý řádek načte do objektu třídy CsvRow. To dělá metoda ReadRow(CsvRow), která vrací true, dokud nedosáhneme konce dat a aktualizuje vlastnosti objektu CsvRow tak, aby obsahoval data právě načteného řádku.

Nyní ještě zbývá udělat pomocnou třídu CsvStreamReaderCardDataProvider, která nám poskytne metodu pro delegáta Func<IEnumerable<ICardData>> pro třídu generující PDF dokument.

public class CsvStreamReaderCardDataProvider : IDisposable

{

    CsvStreamReader reader = null;

    public CsvStreamReaderCardDataProvider(MemoryStream stream)

    {

        this.reader = new CsvStreamReader(stream);

    }

    public IEnumerable<ICardData> GetCardData()

    {

        CsvRow row = new CsvRow();

        while (reader.ReadRow(row))

        {

            if (row.Count < 4)

                continue;

            CsvStreamReaderCardData card = new CsvStreamReaderCardData(row);

            yield return card;

        }

    }

}

Funkčnost třídy je jednoduchá, vytvoří si instanci CsvStreamReaderu a poté v metodě GetCarData čte řádky, převede CsvRow na objekt třídy implementující ICardData – v tomto případě na objekt třídy CsvStreamReaderCardData, která je potomkem abstraktní třídy CardData:

public class CsvStreamReaderCardData : CardData

{

    public CsvStreamReaderCardData(CsvRow row)

    {

        this.Word = row[0];

        this.Pronunciation = row[1];

        this.Example = row[2];

        this.Meaning = row[3];

        if (row.Count > 4)

            this.ExampleTranslation = row[4];

        else

            this.ExampleTranslation = string.Empty;

    }

}

Proč vlastně stream a ne soubor (aneb iTextSharp v paměti)?

Jak jsem nastínil již v úvodu, má celá aplikace bežet v cloudu. Tam ukládání a čtení souborů může představovat problém – a protože nepředpokládám velké soubory, tak se veškeré zpracování (upload od uživatele a čtení) odehraje jen v paměti.

Výše uvedené má ještě jeden dopad – při generování PDF souboru se tento vytvářel na disku. Nyní i tento dokument musíme vytvořit v paměti a poté poslat uživateli zpět, tedy místo tohoto kódu:

PdfWriter writer = PdfWriter.GetInstance(pdfDocument,

                        new FileStream(

                        Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments), 

                        "Flashcards.pdf"),

                        FileMode.Create));

použijeme tento kód:

var stream = new MemoryStream();

PdfWriter writer = iTextSharp.text.pdf.PdfWriter.GetInstance(pdfDocument, stream);

writer.CloseStream = false;

Souhrn změn původní aplikace

Mimo změny v typu aplikace (z konzolové na knihovnu) a způsobu načítání dat došlo i k dalším změnám:

Hlavní kód se přesunul ze souboru Program.cs do souboru Creator.cs, stejně se změnili i názvy tříd (program na Creator).

Třída Creator má jednu hlavní metodu CreatePdf, která vyžaduje dva vstupní paramatry – metodu pro získání údajů kartiček a třídu fontů, které se mají použít

správné umístnění kartičky na A4 je řešeno pomocí dvou statických funkcí BackNextPositionProvider a FrontNExtPositionProvider – zpřehlednil se tak tisk stránky, který se odehrává v metodě PrintFlashCardPage

kartičky se ze zdoje načítají do jediného pole, to se navíc při zpracování stránky neinicilizuje znovu, ale pouze se vyprázdní příkazem Array.Clear(pageCardData, 0, pageCardData.Length);

Zpracování je nyní toto:

zavolá se metoda CreatePdf – inicilizuje se pdf dokument

Načtou se kartičky pro stránku pomocí odkazu na metodu getCardData

Zavolá se metoda pro vložení stránky, které se mimo pole kartiček předají i odkazy na metodu vyrábějící kartičky pro rubovou stránku a odpovídají metoda pro výpočet polohy kartiček na stránce (tedy odkazy na metody CreateForeignFlashcard a FrontNextPositionProvider)

Totéž se provede i pro lícovou stránku, jen se předávají metody CreateNativeFlashcard a BackNextPositionProvider

Metoda CreatePdf vrátí vytvořený Pfd dokument jako stream

Mimo výše uvedené jsou v projektu třídy pro získání dat z CSV souborů a ze sešitů Excel.

Třída FlashcardFonts

Tato třída obsahuje fonty používané pro vypsání textů na kartičky. Protože má aplikace fungovat na webu, je nutné šetřit systémové prostředky a tedy stačí vytvořit tyto fonty jen jednou a poté je sdílet pro všechna volání objektů třídy Creator a jejich metody CreatePdf – pro všechna tato volání se použije stejná instance.

Protože jsou kartičky vykreslovány pomocí fontu Arial, je tento font přidán do AppData webovské aplikace a ve tříde FlashcardFonts pak slouží pro inicializaci základního fontu, ze kterého pak výchází ostatní.

Web aplikace

Web aplikace využívá knihovnu pro tvorbu Pdf dokumentů. Je to MVC3 aplikace vytvořená ze šablony visual studia, obsahuje jen jeden controller nazvaný Home, který zobrazí jednoduchý formulář umožňující upload souboru:

@using (Html.BeginForm("UploadCsv", "Home", FormMethod.Post, new { enctype = "multipart/form-data" }))

{

    <input type="file" name="file" id="file" />

    <input type="submit" value="submit" />

}

Data odeslaná tímto formulářem na server jsou zpracována v metodě UploadCsv:

MemoryStream downloadStream;

string fileName;

using (MemoryStream uploadedStream = new MemoryStream())

{

    Request.Files[0].InputStream.CopyTo(uploadedStream);

    fileName = Path.GetFileNameWithoutExtension(Request.Files[0].FileName);

    uploadedStream.Position = 0;

    using (CsvStreamReaderCardDataProvider provider = new CsvStreamReaderCardDataProvider(uploadedStream))

    {

        Creator creator = new Creator();

        downloadStream = creator.CreatePdf(provider.GetCardData, fonts);

    }

}

downloadStream.Position = 0;

return new FileStreamResult(downloadStream, "application/pdf")

{

    FileDownloadName = fileName + "_flashcard.pdf"

};

Obsah odeslaného souboru je vložen do streamu (Request.Files[0].InputStream.CopyTo(uploadedStream);) , následně je tento stream čten pomocí CsvReaderu (ten je skryt v objektu provider) pomocí objektu provider . Následně je zavolán Creator, jako zdroj údajů o kartičkách mu slouží metoda GetCardData objektu provider – objekt creator pak vytvoří stream obsahující Pdf dokument. Ten je následně odeslán zpět uživateli jako application/pdf s názvem odpovídajíc šabloně <jméno souboru>_flashcard.pdf.

Sdílíme zdrojový kód –CodePlex

V příloze k tomuto článku už nenaleznete zdrojový kód popisovaného řešení – ten je nyní umístněn na CodePlex serveru a to na adrese http://flashcardcreator.codeplex.com. Zdrojový kód si můžete volně procházet přímo v prohlížeči, popřípadě stáhnout a upravit jak chcete:

Poznámka – co je to CodePlex?

Dle wikipedie: CodePlex je internetový projekt společnosti Microsoft určený k hostování otevřeného softwaru. CodePlex byl založen v květnu 2009. K repozitářům lze přistupovat pomocí verzovacích systémů Team Foundation Server nebo Subversion. Uživatelé mají dále k dispozici nástroje pro sledování požadavků, chyb, podporu RSS, statistiky, diskuzní fóra,, vlastní Wiki atd. Ač se většina zdejších projektů týká .NET Frameworku, včetně ASP.NET a Microsoft SharePointu, jsou zde projekty zabývající se SQL, WPF a Windows Forms a další.

Jdeme do oblak

Náš projekt z CodePlex můžeme vystavit přímo na web díky službě AppHarbor. Základní verze služby je zdarma a zprovoznění je za normálních podmínek otázkou několika minut. V nápovědě AppHarbor naleznete i postup, jak spojit CodePlex s vaší aplikací – a při každém commitu/check-inu zdrojového kódu dojde i k aktualizace aplikace na AppHarbor.

Zatím jsem se ale setkal s těmito problémy:

ne každý commit zdrojového kódu na CodePlex se promítne do AppHarbor – AppHarbor dělá build jednou za cca 14-15 minut – i tak je mezi aktualizací zdrojových kódů na CodePlex a aktualizací AppHarbor občas několikaminutová prodleva:

CodePlex:

AppHarbor:

Vložil jsem souboru arial.ttf do složky App_Data, ale zapomněl jsem nastavit (přenastavit) ve vlastnostech Build Action na Content. Což vedlo k tomu, že při lokálním spuštění vše fungovalo, ale na AppHarbor soubor fyzicky nebyl – trvalo mi dost dlouho, než jsem přišel na to, kde je chyba – uznávám, je to školácká chyba. Kdybych použil svůj osvědčený postup spočívající v samostatném webu na lokálním IIS a deploymentu z VS, tak bych na to přišel dříve.

Nepopisuji podrobně, jak s oběma bezplatnými službami pracovat – obě požadují vytvoření účtu, což by nikomu nemělo činit problém a založení projektu na obou z nich je velmi jednoduché a přímočaré – v případě problémů existují diskuzní fóra i nápovědy u obou služeb.

Služba běží na adrese http://flashcard.apphb.com a základní rozhraní je velmi jednoduché:

Stačí vybrat soubor (ukázka souboru ve formátu UTF-8 CSV je přiložena jako slovicka.txt) a odeslat na server. Zpět vám přijde PDF dokument.

Závěr

Prosím mějte na paměti, že kód je pouze demonstrační. Řetez událostí vypadá při použití CodePlex a AppHarbor takto: vývojář udělá změny a provede check-in změn do CodePlex. CodePlex upozorní AppHarbor na změnu, AppHarbor získá z CodePlex zdrojové kódy, zbuilduje je a nasadí.

Martin's corner

neděle 18. prosince 2011

Vzhůru do oblak!…..a stejně skončíme v přístavu