hledger-web-0.26/0000755000000000000000000000000012550610471012015 5ustar0000000000000000hledger-web-0.26/Application.hs0000644000000000000000000000552012550610471014616 0ustar0000000000000000{-# OPTIONS_GHC -fno-warn-orphans #-} {-# LANGUAGE CPP, OverloadedStrings, TemplateHaskell #-} module Application ( makeApplication , getApplicationDev , makeFoundation ) where import Data.IORef import Import import Yesod.Default.Config import Yesod.Default.Main import Yesod.Default.Handlers import Network.Wai.Middleware.RequestLogger (logStdoutDev, logStdout) import Network.HTTP.Conduit (newManager) import Prelude (head) -- adapt to http-conduit 1.x or 2.x when cabal macros are available, otherwise assume 2.x #ifdef MIN_VERSION_http_conduit #if MIN_VERSION_http_conduit(2,0,0) #define http_conduit_2 #endif #else #define http_conduit_2 #endif #ifdef http_conduit_2 import Network.HTTP.Client (defaultManagerSettings) #else import Network.HTTP.Conduit (def) #endif -- Import all relevant handler modules here. -- Don't forget to add new modules to your cabal file! import Handler.RootR import Handler.JournalR import Handler.RegisterR import Handler.SidebarR import Hledger.Web.Options (WebOpts(..), defwebopts) import Hledger.Data (Journal, nulljournal) import Hledger.Read (readJournalFile) import Hledger.Utils (error') import Hledger.Cli.Options (defcliopts, journalFilePathFromOpts) -- This line actually creates our YesodDispatch instance. It is the second half -- of the call to mkYesodData which occurs in Foundation.hs. Please see the -- comments there for more details. mkYesodDispatch "App" resourcesApp -- This function allocates resources (such as a database connection pool), -- performs initialization and creates a WAI application. This is also the -- place to put your migrate statements to have automatic database -- migrations handled by Yesod. makeApplication :: WebOpts -> Journal -> AppConfig DefaultEnv Extra -> IO Application makeApplication opts j conf = do foundation <- makeFoundation conf opts writeIORef (appJournal foundation) j app <- toWaiAppPlain foundation return $ logWare app where logWare | development = logStdoutDev | server_ opts = logStdout | otherwise = id makeFoundation :: AppConfig DefaultEnv Extra -> WebOpts -> IO App makeFoundation conf opts = do manager <- newManager #ifdef http_conduit_2 defaultManagerSettings #else def #endif s <- staticSite jref <- newIORef nulljournal return $ App conf s manager opts jref -- for yesod devel -- uses the journal specified by the LEDGER_FILE env var, or ~/.hledger.journal getApplicationDev :: IO (Int, Application) getApplicationDev = do f <- head `fmap` journalFilePathFromOpts defcliopts -- XXX head should be safe for now j <- either error' id `fmap` readJournalFile Nothing Nothing True f defaultDevelApp loader (makeApplication defwebopts j) where loader = Yesod.Default.Config.loadConfig (configSettings Development) { csParseExtra = parseExtra } hledger-web-0.26/CHANGES0000644000000000000000000000654112550610471013016 0ustar0000000000000000User-visible changes in hledger-web. See also hledger's change log. 0.26 (2015/7/12) - make the j keybinding respect --base-url (fixes #271) - respect command line options (fixes #225) - include the unminified jquery source again (#161) - fix build breakage from #165 (fixes #268) - fix a js error breaking add form in browsers other than firefox (#251, Carlos Lopez-Camey ) - drop deprecated network-conduit dependency 0.25 (2015/4/7) - GHC 7.10 compatibility (#239) - fix the add form when there are included files (#234) NB to make this work, the add form now shows the full file path of the main and included journal files. - improve add form validation (#223, #234) All add form errors are displayed as form errors, not internal server errors, and when there are errors the add form is redisplayed (form inputs are not preserved, currently). - keep the add button right-aligned when pressing ctrl - on the add form 0.24.1 (2015/1/10) - add missing modules to fix cabal tests (#232) 0.24 (2014/12/25) General: - fix: add missing hs/js files to package - the web UI has been streamlined, dropping the raw and entries views and the edit form - the help dialog has been improved - keyboard shortcuts are now available - the sidebar can be toggled open or closed (press s) Journal view: - layout tweaks for less truncation of descriptions and account names Register view: - fix: don't show all zero amounts when searching by account within an account register view - chart improvements: show zero balances with correct commodity; show accurate balance at all dates; show transaction events & tooltips; show zero/today lines & background colors Add form: - parses data more strictly and gives better errors (eg #194) - allows any number of postings, not just two - after adding a transaction, goes back to the journal - keyboard shortcut (a) allows quick access Dependencies: - allow warp 3*, wai-handler-launch 3* - require yesod 1.4* (fixes #212) - js updated (jquery, bootstrap, flot), added (typeahead, cookie, hotkeys), removed (select2) 0.23.3 (2014/9/12) - remove warp, wai-handler-launch upper bounds (fixes #205) 0.23.2 (2014/5/8) - depend on latest hledger 0.23.1 (2014/5/7) - depend on latest hledger 0.23 (2014/5/1) - The --static-root flag has been renamed to --file-url. - hledger-web now builds with Cabal's default -O, not -O2, so may be a little quicker/less memory-hungry to install. 0.22.8 (2014/4/29) - allow shakespeare 2.* (#179) 0.22.7 (2014/4/17) - add Peter Simons' patch fixing Data.Conduit.Network HostIPv4 error (#171) 0.22.6 (2014/4/16) - depend on hledger[-lib] 0.22.2 0.22.5 (2014/4/15) - allow http-client 0.3.*, fixing cabal install again with GHC <= 7.6 (not yet 7.8) - use pretty-show only with GHC 7.4+, fixing GHC 7.2 (fixes #155) - allow warp 2.1, fixing cabal install 0.22.4 (2014/2/10) - Fix: include the right unminified version of jquery.url.js (1.1) to avoid js breakage 0.22.3 (2014/2/10) - Fix: version number reported by --version 0.22.2 (2014/2/10) - new option --static-root to set the base url for static files - allow blaze-html 0.7 (#159) - Fix: include unminified source of all javascript to help packagers (#161) - Fix: work around clang-related build failures with OS X mavericks/XCode 5 0.22.1 (2014/1/6) and older See http://hledger.org/release-notes or doc/RELNOTES.md. hledger-web-0.26/Foundation.hs0000644000000000000000000004006512550610471014464 0ustar0000000000000000{-# LANGUAGE CPP, MultiParamTypeClasses, OverloadedStrings, RecordWildCards, QuasiQuotes, TemplateHaskell, TypeFamilies, TypeSynonymInstances, FlexibleInstances #-} {- Define the web application's foundation, in the usual Yesod style. See a default Yesod app's comments for more details of each part. -} module Foundation where import Prelude #if !MIN_VERSION_base(4,8,0) import Control.Applicative ((<$>)) #endif import Data.IORef import Yesod import Yesod.Static import Yesod.Default.Config #ifndef DEVELOPMENT import Yesod.Default.Util (addStaticContentExternal) #endif import Network.HTTP.Conduit (Manager) -- import qualified Settings import Settings.Development (development) import Settings.StaticFiles import Settings (staticRoot, widgetFile, Extra (..)) #ifndef DEVELOPMENT import Settings (staticDir) import Text.Jasmine (minifym) #endif import Text.Blaze.Html.Renderer.String (renderHtml) import Text.Hamlet (hamletFile) import Hledger.Web.Options import Hledger.Data.Types -- import Hledger.Web.Settings -- import Hledger.Web.Settings.StaticFiles -- for addform import Data.List import Data.Maybe import Data.Text as Text (Text,pack,unpack) import Data.Time.Calendar #if BLAZE_HTML_0_4 import Text.Blaze (preEscapedString, Markup) #else import Text.Blaze (Markup) import Text.Blaze.Internal (preEscapedString) #endif import Text.JSON import Hledger.Data.Journal import Hledger.Query import Hledger hiding (is) import Hledger.Cli hiding (version) -- | The site argument for your application. This can be a good place to -- keep settings and values requiring initialization before your application -- starts running, such as database connections. Every handler will have -- access to the data present here. data App = App { settings :: AppConfig DefaultEnv Extra , getStatic :: Static -- ^ Settings for static file serving. , httpManager :: Manager -- , appOpts :: WebOpts , appJournal :: IORef Journal } -- Set up i18n messages. See the message folder. mkMessage "App" "messages" "en" -- This is where we define all of the routes in our application. For a full -- explanation of the syntax, please see: -- http://www.yesodweb.com/book/handler -- -- This function does three things: -- -- * Creates the route datatype AppRoute. Every valid URL in your -- application can be represented as a value of this type. -- * Creates the associated type: -- type instance Route App = AppRoute -- * Creates the value resourcesApp which contains information on the -- resources declared below. This is used in Handler.hs by the call to -- mkYesodDispatch -- -- What this function does *not* do is create a YesodSite instance for -- App. Creating that instance requires all of the handler functions -- for our application to be in scope. However, the handler functions -- usually require access to the AppRoute datatype. Therefore, we -- split these actions into two functions and place them in separate files. mkYesodData "App" $(parseRoutesFile "config/routes") -- | A convenience alias. type AppRoute = Route App type Form x = Html -> MForm (HandlerT App IO) (FormResult x, Widget) -- Please see the documentation for the Yesod typeclass. There are a number -- of settings which can be configured by overriding methods here. instance Yesod App where approot = ApprootMaster $ appRoot . settings -- Store session data on the client in encrypted cookies, -- default session idle timeout is 120 minutes makeSessionBackend _ = fmap Just $ defaultClientSessionBackend (120 * 60) ".hledger-web_client_session_key.aes" defaultLayout widget = do master <- getYesod lastmsg <- getMessage vd@VD{..} <- getViewData -- We break up the default layout into two components: -- default-layout is the contents of the body tag, and -- default-layout-wrapper is the entire page. Since the final -- value passed to hamletToRepHtml cannot be a widget, this allows -- you to use normal widget features in default-layout. -- pc <- widgetToPageContent $ do -- $(widgetFile "normalize") -- addStylesheet $ StaticR css_bootstrap_css -- $(widgetFile "default-layout") -- hamletToRepHtml $(hamletFile "templates/default-layout-wrapper.hamlet") pc <- widgetToPageContent $ do $(widgetFile "normalize") addStylesheet $ StaticR css_bootstrap_min_css -- load these things early, in HEAD: toWidgetHead [hamlet| |] addScript $ StaticR js_bootstrap_min_js -- addScript $ StaticR js_typeahead_bundle_min_js addScript $ StaticR js_jquery_url_js addScript $ StaticR js_jquery_cookie_js addScript $ StaticR js_jquery_hotkeys_js addScript $ StaticR js_jquery_flot_min_js addScript $ StaticR js_jquery_flot_time_min_js addScript $ StaticR js_jquery_flot_tooltip_min_js toWidget [hamlet| \ |] addStylesheet $ StaticR hledger_css addScript $ StaticR hledger_js $(widgetFile "default-layout") staticRootUrl <- (staticRoot . settings) <$> getYesod withUrlRenderer $(hamletFile "templates/default-layout-wrapper.hamlet") -- This is done to provide an optimization for serving static files from -- a separate domain. Please see the staticRoot setting in Settings.hs urlRenderOverride y (StaticR s) = Just $ uncurry (joinPath y (Settings.staticRoot $ settings y)) $ renderRoute s urlRenderOverride _ _ = Nothing #ifndef DEVELOPMENT -- This function creates static content files in the static folder -- and names them based on a hash of their content. This allows -- expiration dates to be set far in the future without worry of -- users receiving stale content. addStaticContent = addStaticContentExternal minifym base64md5 Settings.staticDir (StaticR . flip StaticRoute []) #endif -- Place Javascript at bottom of the body tag so the rest of the page loads first jsLoader _ = BottomOfBody -- What messages should be logged. The following includes all messages when -- in development, and warnings and errors in production. shouldLog _ _source level = development || level == LevelWarn || level == LevelError -- This instance is required to use forms. You can modify renderMessage to -- achieve customized and internationalized form validation messages. instance RenderMessage App FormMessage where renderMessage _ _ = defaultFormMessage -- | Get the 'Extra' value, used to hold data from the settings.yml file. getExtra :: Handler Extra getExtra = fmap (appExtra . settings) getYesod -- Note: previous versions of the scaffolding included a deliver function to -- send emails. Unfortunately, there are too many different options for us to -- give a reasonable default. Instead, the information is available on the -- wiki: -- -- https://github.com/yesodweb/yesod/wiki/Sending-email ---------------------------------------------------------------------- -- template and handler utilities -- view data, used by the add form and handlers -- | A bundle of data useful for hledger-web request handlers and templates. data ViewData = VD { opts :: WebOpts -- ^ the command-line options at startup ,here :: AppRoute -- ^ the current route ,msg :: Maybe Html -- ^ the current UI message if any, possibly from the current request ,today :: Day -- ^ today's date (for queries containing relative dates) ,j :: Journal -- ^ the up-to-date parsed unfiltered journal ,q :: String -- ^ the current q parameter, the main query expression ,m :: Query -- ^ a query parsed from the q parameter ,qopts :: [QueryOpt] -- ^ query options parsed from the q parameter ,am :: Query -- ^ a query parsed from the accounts sidebar query expr ("a" parameter) ,aopts :: [QueryOpt] -- ^ query options parsed from the accounts sidebar query expr ,showpostings :: Bool -- ^ current p parameter, 1 or 0 shows/hides all postings where applicable ,showsidebar :: Bool -- ^ current showsidebar cookie value } deriving (Show) instance Show Text.Blaze.Markup where show _ = "" -- | Make a default ViewData, using day 0 as today's date. nullviewdata :: ViewData nullviewdata = viewdataWithDateAndParams nulldate "" "" "" -- | Make a ViewData using the given date and request parameters, and defaults elsewhere. viewdataWithDateAndParams :: Day -> String -> String -> String -> ViewData viewdataWithDateAndParams d q a p = let (querymatcher,queryopts) = parseQuery d q (acctsmatcher,acctsopts) = parseQuery d a in VD { opts = defwebopts ,j = nulljournal ,here = RootR ,msg = Nothing ,today = d ,q = q ,m = querymatcher ,qopts = queryopts ,am = acctsmatcher ,aopts = acctsopts ,showpostings = p == "1" ,showsidebar = False } -- | Gather data used by handlers and templates in the current request. getViewData :: Handler ViewData getViewData = do app <- getYesod let opts@WebOpts{cliopts_=copts@CliOpts{reportopts_=ropts}} = appOpts app (j, merr) <- getCurrentJournal app copts{reportopts_=ropts{no_elide_=True}} lastmsg <- getLastMessage let msg = maybe lastmsg (Just . toHtml) merr Just here <- getCurrentRoute today <- liftIO getCurrentDay q <- getParameterOrNull "q" a <- getParameterOrNull "a" p <- getParameterOrNull "p" -- a "sidebar" query parameter overrides the "showsidebar" cookie sidebarparam <- lookupGetParam (pack "sidebar") cookies <- reqCookies <$> getRequest let sidebarcookie = lookup "showsidebar" cookies let showsidebar = maybe (sidebarcookie == Just "1") (=="1") sidebarparam return (viewdataWithDateAndParams today q a p){ opts=opts ,msg=msg ,here=here ,today=today ,j=j ,showsidebar=showsidebar } where -- | Update our copy of the journal if the file changed. If there is an -- error while reloading, keep the old one and return the error, and set a -- ui message. getCurrentJournal :: App -> CliOpts -> Handler (Journal, Maybe String) getCurrentJournal app opts = do -- XXX put this inside atomicModifyIORef' for thread safety j <- liftIO $ readIORef $ appJournal app (jE, changed) <- liftIO $ journalReloadIfChanged opts j if not changed then return (j,Nothing) else case jE of Right j' -> do liftIO $ writeIORef (appJournal app) j' return (j',Nothing) Left e -> do setMessage $ "error while reading" {- ++ ": " ++ e-} return (j, Just e) -- | Get the named request parameter, or the empty string if not present. getParameterOrNull :: String -> Handler String getParameterOrNull p = unpack `fmap` fromMaybe "" <$> lookupGetParam (pack p) -- | Get the message that was set by the last request, in a -- referentially transparent manner (allowing multiple reads). getLastMessage :: Handler (Maybe Html) getLastMessage = cached getMessage -- add form dialog, part of the default template -- | Add transaction form. addform :: Text -> ViewData -> HtmlUrl AppRoute addform _ vd@VD{..} = [hamlet| " "<\\/script>" -- #236 listToJsonValueObjArrayStr as = preEscapedString $ escapeJSSpecialChars $ encode $ JSArray $ map (\a -> JSObject $ toJSObject [("value", showJSON a)]) as numpostings = 4 postingnums = [1..numpostings] postingfields :: ViewData -> Int -> HtmlUrl AppRoute postingfields _ n = [hamlet| ^{amtfieldorsubmitbtn} |] where islast = n == numpostings acctvar = "account" ++ show n acctph = "Account " ++ show n amtfieldorsubmitbtn | not islast = [hamlet| |] | otherwise = [hamlet|