Added Check for Invalid Characters in Sentences

code/drasil-data/Data/Drasil/Citations.hs

@@ -30,18 +30,18 @@ koothoor2013 =
 parnas1972 = cArticle [dParnas]
   "On the Criteria To Be Used in Decomposing Systems into Modules"
   "Communications of the ACM" 1972
-  [pages [1053, 1058]] "dParnas1972"
+  [pages [1053..1058]] "dParnas1972"
 
 parnasClements1984 = cInProceedings
   [dParnas, pcClements, dmWiess]
   "The Modular Structure of Complex Systems"
   "ICSE '84: Proceedings of the 7th international conference on Software engineering"
-  1984 [pages [408, 417]] "parnasClements1984"
+  1984 [pages [408..417]] "parnasClements1984"
 
 parnasClements1986 = cArticle [dParnas, pcClements] 
   "A rational design process: How and why to fake it"
   "IEEE Transactions on Software Engineering" 1986
-  [month Feb, volume 12, number 2, pages [251,257], address "Washington, USA"]
+  [month Feb, volume 12, number 2, pages [251..257], address "Washington, USA"]
   "parnasClements1986"
 
 smithLai2005 = cInProceedings [spencerSmith, lLai]
@@ -51,7 +51,7 @@ smithLai2005 = cInProceedings [spencerSmith, lLai]
   "Techniques and Tools to Support Situation-Specific Requirements " ++
   "Engineering Processes, SREP'05") 2005
   [ editor [pjAgerfalk, nKraiem, jRalyte], address "Paris, France"
-  , pages [107,121], 
+  , pages [107..121], 
   note "In conjunction with 13th IEEE International Requirements Engineering Conference,"] 
   "smithLai2005"
 

code/drasil-example/Drasil/GamePhysics/References.hs

@@ -18,7 +18,7 @@ citations = [parnas1978, sciComp2013, parnas1972, parnasClements1984,
 parnas1978 = cInProceedings [dParnas]
     "Designing Software for Ease of Extension and Contraction"
     "ICSE '78: Proceedings of the 3rd international conference on Software engineering" 
-    1978 [pages [264,277]] "parnas1978"
+    1978 [pages [264..277]] "parnas1978"
 
 sciComp2013 = cArticle
   [gWilson, daAruliah, cTitus, nChueHong, mDavis, rGuy, shdHaddock,

code/drasil-example/Drasil/SSP/References.hs

@@ -17,18 +17,18 @@ chen2005, fredlund1977, li2010, karchewski2012, huston2008,
 --See Language.Drasil.People for all person constructors
 chen2005 = cArticle [qhQian, dyZhu, cfLee, grChen]
   "A concise algorithm for computing the factor of safety using the morgenstern price method"
-  jnlCGJ 2005 [month Feb, volume 42, number 1, pages [272,278]]
+  jnlCGJ 2005 [month Feb, volume 42, number 1, pages [272..278]]
   "chen2005"
 
 fredlund1977 = cArticle [dgFredlund, jKrahn]
   "Comparison of slope stability methods of analysis"
-  jnlCGJ 1977 [month Apr, pages [429, 439], volume 14, number 3]
+  jnlCGJ 1977 [month Apr, pages [429..439], volume 14, number 3]
   "fredlund1977"
 
 li2010 = cArticle [yCLi, ymChen, tltZhan, ssLing, pjCleall]
   ("An efficient approach for locating the critical slip surface in" ++
   " slope stability analyses using a real-coded genetic algorithm")
-  jnlCGJ 2010 [month Jun, pages [806,820], volume 47, number 7]
+  jnlCGJ 2010 [month Jun, pages [806..820], volume 47, number 7]
   "li2010"
 
 karchewski2012 = cInProceedings [bKarchewski, pGuo, dStolle]
@@ -37,8 +37,10 @@ karchewski2012 = cInProceedings [bKarchewski, pGuo, dStolle]
   [address "Winnipeg, MB, Canada", organization "Canadian Geotechnical Society"] 
   "karchewski2012"
 
-huston2008 = cBookA [rHuston, hJosephs] ("Practical stress analysis in " ++  
-  "engineering design") "CRC Press" 2008 [edition 3] "huston2008"
+huston2008 = cBookA [rHuston, hJosephs] "Practical stress analysis in engineering design"
+  "CRC Press" 2008 [edition 3] "huston2008"
 
-morgenstern1965 = cArticle [nrMorgenstern, vePrice] ("The analysis of the " ++   "stability of general slip surfaces") "Géotechnique" 1965 [month Jan,
-  pages [79,93], number 15] "morgenstern1965"
+morgenstern1965 = cArticle [nrMorgenstern, vePrice]
+  "The analysis of the stability of general slip surfaces"
+  "Géotechnique" 1965 [month Jan, pages [79..93], number 15]
+  "morgenstern1965"

code/drasil-printers/Language/Drasil/HTML/Print.hs

@@ -5,6 +5,7 @@ import Data.List (intercalate, partition, sortBy)
 import Text.PrettyPrint hiding (Str)
 import Numeric (showEFloat)
 import Control.Arrow (second)
+import Utils.Drasil (checkValidStr, numList)
 
 import qualified Language.Drasil as L (People, Person, 
   CitationKind(Misc, Book, MThesis, PhDThesis, Article), 
@@ -92,20 +93,24 @@ titleSpec s         = pSpec s
 
 -- | Renders the Sentences in the HTML body (called by 'printLO')
 pSpec :: Spec -> Doc
-pSpec (E e)             = em $ pExpr e
-pSpec (a :+: b)         = pSpec a <> pSpec b
-pSpec (S s)             = text s
-pSpec (Sy s)            = text $ uSymb s
-pSpec (Sp s)            = text $ unPH $ L.special s
-pSpec HARDNL            = text "<br />"
+pSpec (E e)     = em $ pExpr e
+pSpec (a :+: b) = pSpec a <> pSpec b
+pSpec (S s)     = either error (text . concatMap escapeChars) $ checkValidStr s invalid
+  where
+    invalid = ['<', '>']
+    escapeChars '&' = "\\&"
+    escapeChars c = [c]
+pSpec (Sy s)    = text $ uSymb s
+pSpec (Sp s)    = text $ unPH $ L.special s
+pSpec HARDNL    = text "<br />"
 pSpec (Ref Internal r a)      = reflink     r $ pSpec a
 pSpec (Ref Cite2    r EmptyS) = reflink     r $ text r -- no difference for citations?
 pSpec (Ref Cite2    r a)      = reflinkInfo r (text r) (pSpec a) -- no difference for citations?
 pSpec (Ref External r a)      = reflinkURI  r $ pSpec a
-pSpec EmptyS             = text "" -- Expected in the output
-pSpec (Quote q)          = doubleQuotes $ pSpec q
--- pSpec (Acc Grave c)     = text $ '&' : c : "grave;" --Only works on vowels.
--- pSpec (Acc Acute c)     = text $ '&' : c : "acute;" --Only works on vowels.
+pSpec EmptyS    = text "" -- Expected in the output
+pSpec (Quote q) = doubleQuotes $ pSpec q
+--pSpec (Acc Grave c) = text $ '&' : c : "grave;" --Only works on vowels.
+--pSpec (Acc Acute c) = text $ '&' : c : "acute;" --Only works on vowels.
 
 -- | Renders symbols for HTML document
 symbol :: L.Symbol -> String
@@ -322,12 +327,12 @@ makeBib = ul ["hide-list-style"] . vcat .
 
 --for when we add other things to reference like website, newspaper
 renderCite :: Citation -> (Doc, Doc)
-renderCite (Cite e L.Book cfs) = (text e, renderF cfs useStyleBk <> text " Print.")
-renderCite (Cite e L.Article cfs) = (text e, renderF cfs useStyleArtcl <> text " Print.")
-renderCite (Cite e L.MThesis cfs) = (text e, renderF cfs useStyleBk <> text " Print.")
-renderCite (Cite e L.PhDThesis cfs) = (text e, renderF cfs useStyleBk <> text " Print.")
-renderCite (Cite e L.Misc cfs) = (text e, renderF cfs useStyleBk)
-renderCite (Cite e _ cfs) = (text e, renderF cfs useStyleArtcl) --FIXME: Properly render these later.
+renderCite (Cite e L.Book cfs)      = (text e, renderF cfs useStyleBk    <> text " Print.")
+renderCite (Cite e L.Article cfs)   = (text e, renderF cfs useStyleArtcl <> text " Print.")
+renderCite (Cite e L.MThesis cfs)   = (text e, renderF cfs useStyleBk    <> text " Print.")
+renderCite (Cite e L.PhDThesis cfs) = (text e, renderF cfs useStyleBk    <> text " Print.")
+renderCite (Cite e L.Misc cfs)      = (text e, renderF cfs useStyleBk)
+renderCite (Cite e _ cfs)           = (text e, renderF cfs useStyleArtcl) --FIXME: Properly render these later.
 
 renderF :: [CiteField] -> (StyleGuide -> (CiteField -> Doc)) -> Doc
 renderF fields styl = hsep $ map (styl bibStyleH) (sortBy compCiteField fields)
@@ -402,39 +407,36 @@ bookMLA (Year      y) = dot $ text $ show y
 --bookMLA (URLdate d m y) = "Web. " ++ bookMLA (Date d m y) sm
 bookMLA (BookTitle s) = dot $ em $ pSpec s
 bookMLA (Journal   s) = comm $ em $ pSpec s
-bookMLA (Pages   [n]) = dot $ text $ "p. " ++ show n
-bookMLA (Pages [a,b]) = dot $ text $ "pp. " ++ show a ++ "&ndash;" ++ show b
-bookMLA (Pages     _) = error "Page range specified is empty or has more than two items"
+bookMLA (Pages   [p]) = dot $ text $ "pg. " ++ show p
+bookMLA (Pages     p) = dot $ text "pp. " <> foldPages p
 bookMLA (Note      s) = pSpec s
 bookMLA (Number    n) = comm $ text ("no. " ++ show n)
 bookMLA (School    s) = comm $ pSpec s
 --bookMLA (Thesis     t)  = comm $ show t
 --bookMLA (URL        s)  = dot $ pSpec s
-bookMLA (HowPublished (Verb s)) = comm $ pSpec s
-bookMLA (HowPublished (URL l@(S s))) = dot $ pSpec $ Ref External s l
-bookMLA (HowPublished (URL s))       = dot $ pSpec s
-bookMLA  (Editor     p)    = comm $ text "Edited by " <> pSpec (foldlList (map (S . L.nameStr) p))
-bookMLA (Chapter _)       = text ""
-bookMLA (Institution i)   = comm $ pSpec i
-bookMLA (Organization i)  = comm $ pSpec i
-bookMLA (Month m)         = comm $ text $ show m
-bookMLA (Type t)          = comm $ pSpec t
+bookMLA (HowPublished (Verb s))      = comm $ pSpec s
+bookMLA (HowPublished (URL l@(S s))) = dot  $ pSpec $ Ref External s l
+bookMLA (HowPublished (URL s))       = dot  $ pSpec s
+bookMLA (Editor       p) = comm $ text "Edited by " <> foldPeople p
+bookMLA (Chapter      _) = text ""
+bookMLA (Institution  i) = comm $ pSpec i
+bookMLA (Organization i) = comm $ pSpec i
+bookMLA (Month        m) = comm $ text $ show m
+bookMLA (Type         t) = comm $ pSpec t
 
 bookAPA :: CiteField -> Doc --FIXME: year needs to come after author in L.APA
 bookAPA (Author   p) = pSpec (rendPeople L.rendPersLFM' p) --L.APA uses initals rather than full name
 bookAPA (Year     y) = dot $ text $ paren $ show y --L.APA puts "()" around the year
 --bookAPA (Date _ _ y) = bookAPA (Year y) --L.APA doesn't care about the day or month
 --bookAPA (URLdate d m y) = "Retrieved, " ++ (comm $ unwords [show d, show m, show y])
-bookAPA (Pages     [n])  = dot $ text $ show n
-bookAPA (Pages [a,b])    = dot $ text $ show a ++ "&ndash;" ++ show b
-bookAPA (Pages _) = error "Page range specified is empty or has more than two items"
-bookAPA (Editor   p)  = dot $ pSpec (foldlList $ map (S . L.nameStr) p) <> text " (Ed.)"
+bookAPA (Pages    p) = dot $ foldPages p
+bookAPA (Editor   p) = dot $ foldPeople p <> text " (Ed.)"
 bookAPA i = bookMLA i --Most items are rendered the same as L.MLA
 
 bookChicago :: CiteField -> Doc
 bookChicago (Author   p) = pSpec (rendPeople L.rendPersLFM'' p) --L.APA uses middle initals rather than full name
-bookChicago p@(Pages  _) = bookAPA p
-bookChicago (Editor   p) = dot $ pSpec (foldlList $ map (S . L.nameStr) p) <> text (toPlural p " ed")
+bookChicago (Pages    p) = dot $ foldPages p
+bookChicago (Editor   p) = dot $ foldPeople p <> text (toPlural p " ed")
 bookChicago i = bookMLA i --Most items are rendered the same as L.MLA
 
 -- for article renderings
@@ -459,16 +461,22 @@ artclChicago i = bookChicago i
 -- PEOPLE RENDERING --
 rendPeople :: (L.Person -> String) -> L.People -> Spec
 rendPeople _ []  = S "N.a." -- "No authors given"
-rendPeople f people = foldlList $ map (S . f) people --foldlList is in SentenceStructures.hs
+rendPeople f people = S . foldlList $ map f people --foldlList is in drasil-utils
 
 rendPeople' :: L.People -> Spec
 rendPeople' []  = S "N.a." -- "No authors given"
-rendPeople' people = foldlList $ map (S . rendPers) (init people) ++  [S (rendPersL $ last people)]
+rendPeople' people = S . foldlList $ map rendPers (init people) ++  [rendPersL (last people)]
+
+foldPages :: [Int] -> Doc
+foldPages = text . foldlList . numList "&ndash;"
+
+foldPeople :: L.People -> Doc
+foldPeople p = text . foldlList $ map L.nameStr p
 
-foldlList :: [Spec] -> Spec
-foldlList []    = EmptyS
-foldlList [a,b] = a :+: S " and " :+: b
-foldlList lst   = foldle1 (\a b -> a :+: S ", " :+: b) (\a b -> a :+: S ", and " :+: b) lst
+foldlList :: [String] -> String
+foldlList []    = ""
+foldlList [a,b] = a ++ " and " ++ b
+foldlList lst   = foldle1 (\a b -> a ++ ", " ++ b) (\a b -> a ++ ", and " ++ b) lst
 
 foldle1 :: (a -> a -> a) -> (a -> a -> a) -> [a] -> a
 foldle1 _ _ []       = error "foldle1 cannot be used with empty list"

code/drasil-printers/Language/Drasil/Printing/Import.hs

@@ -1,5 +1,5 @@
-module Language.Drasil.Printing.Import(space,expr,symbol,spec,makeDocument) where
-
+module Language.Drasil.Printing.Import (space, expr, symbol, spec,
+  makeDocument) where
 
 import Language.Drasil hiding (sec, symbol)
 import Language.Drasil.Development (precA, precB, eprec)
@@ -257,17 +257,17 @@ pow sm a                b = P.Row [expr a sm, P.Sup (expr b sm)]
 -- | Print a RealInterval
 renderRealInt :: PrintingInformation -> Symbol -> RealInterval Expr Expr -> P.Expr
 renderRealInt st s (Bounded (Inc,a) (Inc,b)) = 
-  P.Row [ expr a st, P.MO P.LEq, symbol s, P.MO P.LEq, expr b st]
+  P.Row [expr a st, P.MO P.LEq, symbol s, P.MO P.LEq, expr b st]
 renderRealInt st s (Bounded (Inc,a) (Exc,b)) =
-  P.Row [ expr a st, P.MO P.LEq, symbol s, P.MO P.Lt, expr b st]
+  P.Row [expr a st, P.MO P.LEq, symbol s, P.MO P.Lt, expr b st]
 renderRealInt st s (Bounded (Exc,a) (Inc,b)) =
-  P.Row [ expr a st, P.MO P.Lt, symbol s, P.MO P.LEq, expr b st]
+  P.Row [expr a st, P.MO P.Lt, symbol s, P.MO P.LEq, expr b st]
 renderRealInt st s (Bounded (Exc,a) (Exc,b)) =
-  P.Row [ expr a st, P.MO P.Lt, symbol s, P.MO P.Lt, expr b st]
-renderRealInt st s (UpTo (Inc,a))    = P.Row [ symbol s, P.MO P.LEq, expr a st]
-renderRealInt st s (UpTo (Exc,a))    = P.Row [ symbol s, P.MO P.Lt, expr a st]
-renderRealInt st s (UpFrom (Inc,a))  = P.Row [ symbol s, P.MO P.GEq, expr a st]
-renderRealInt st s (UpFrom (Exc,a))  = P.Row [ symbol s, P.MO P.Gt, expr a st]
+  P.Row [expr a st, P.MO P.Lt, symbol s, P.MO P.Lt, expr b st]
+renderRealInt st s (UpTo (Inc,a))   = P.Row [symbol s, P.MO P.LEq, expr a st]
+renderRealInt st s (UpTo (Exc,a))   = P.Row [symbol s, P.MO P.Lt,  expr a st]
+renderRealInt st s (UpFrom (Inc,a)) = P.Row [symbol s, P.MO P.GEq, expr a st]
+renderRealInt st s (UpFrom (Exc,a)) = P.Row [symbol s, P.MO P.Gt,  expr a st]
 
 
 -- | Translates Sentence to the Printing representation of Sentence ('Spec')
@@ -276,7 +276,8 @@ spec :: PrintingInformation -> Sentence -> P.Spec
 spec sm (EmptyS :+: b) = spec sm b
 spec sm (a :+: EmptyS) = spec sm a
 spec sm (a :+: b)      = spec sm a P.:+: spec sm b
-spec _ (S s)           = P.S s
+spec _ (S s)           = either error P.S $ checkValidStr s invalidChars
+  where invalidChars   = ['<', '>', '\"', '&', '#', '$', '%', '&', '~', '^', '\\', '{', '}'] 
 spec _ (Sy s)          = P.Sy s
 spec _ Percent         = P.E $ P.MO P.Perc
 spec _ (P s)           = P.E $ symbol s
@@ -308,38 +309,9 @@ renderCitInfo :: RefInfo -> Sentence
 renderCitInfo  None          = EmptyS
 renderCitInfo (RefNote   rn) = sParen (S rn)
 renderCitInfo (Equation [x]) = sParen (S "Eq." +:+ S (show x))
-renderCitInfo (Equation  i ) = sParen (S "Eqs." +:+ foldNums i)
+renderCitInfo (Equation  i ) = sParen (S "Eqs." +:+ foldNums "-" i)
 renderCitInfo (Page     [x]) = sParen (S "pg." +:+ S (show x))
-renderCitInfo (Page      i ) = sParen (S "pp." +:+ foldNums i)
-
--- | Parses a list of integers into a nice sentence (ie. S "1, 4-7, and 13")
-foldNums :: [Int] -> Sentence
-foldNums x = foldlList Comma List $ map S (numbers x)
-
--- | Helper for foldNums
-numbers :: [Int] -> [String]
-numbers []  = error "Empty list when making reference with additional information"
-numbers [x] = [show x]
-numbers [x, y]
-  | y == x + 1 = [hyp x y]
-  | otherwise  = map show [x, y]
-numbers (x:y:xs)
-  | y == x + 1 = range x y xs
-  | otherwise  = show x : numbers (y:xs)
-
--- | Helper for foldNums
-range :: Int -> Int -> [Int] -> [String]
-range a b []   = [hyp a b]
-range a b [x]
-  | x == b + 1 = [hyp a x]
-  | otherwise  = [hyp a b, show x]
-range a b (x:xs)
-  | x == b + 1 = range a x xs
-  | otherwise  = hyp a b : numbers (x:xs)
-
--- | Helper for foldNums
-hyp :: Int -> Int -> String
-hyp a b = show a ++ "-" ++ show b
+renderCitInfo (Page      i ) = sParen (S "pp." +:+ foldNums "-" i)
 
 -- | Translates from Document to the Printing representation of Document
 makeDocument :: PrintingInformation -> Document -> T.Document

code/drasil-printers/Language/Drasil/TeX/Helpers.hs

@@ -82,17 +82,24 @@ mkEnv nm d =
   d $+$
   pure (text ("\\end" ++ H.brace nm))
 
--- Encapsulate environments with argument
-mkEnvArgs :: String -> String -> D -> D
-mkEnvArgs nm args d =
+-- Encapsulate environments with argument with braces
+mkEnvArgBr :: String -> String -> D -> D
+mkEnvArgBr nm args d =
   pure (text ("\\begin" ++ H.brace nm ++ H.brace args)) $+$ 
   d $+$
   pure (text ("\\end" ++ H.brace nm))
 
+-- Encapsulate environments with argument with brackets
+mkEnvArgSq :: String -> String -> D -> D
+mkEnvArgSq nm args d =
+  pure (text ("\\begin" ++ H.brace nm ++ H.sqbrac args)) $+$ 
+  d $+$
+  pure (text ("\\end" ++ H.brace nm))
+
 -- Makes minipage environment
 mkMinipage :: D -> D
 mkMinipage d = commandD "vspace" (command0 "baselineskip") $+$
-  command0 "noindent" $+$ mkEnvArgs "minipage" "\\textwidth" d
+  command0 "noindent" $+$ mkEnvArgBr "minipage" "\\textwidth" d
 
 -- for defining (LaTeX) macros
 comm :: String -> String -> Maybe String -> D