<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>src/Darcs/Repository/Motd.lhs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
% Copyright (C) 2002-2004 David Roundy
%
% This program is free software; you can redistribute it and/or modify
% it under the terms of the GNU General Public License as published by
% the Free Software Foundation; either version 2, or (at your option)
% any later version.
%
% This program is distributed in the hope that it will be useful,
% but WITHOUT ANY WARRANTY; without even the implied warranty of
% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
% GNU General Public License for more details.
%
% You should have received a copy of the GNU General Public License
% along with this program; see the file COPYING. If not, write to
% the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
% Boston, MA 02110-1301, USA.
\begin{code}
<pre><a name="line-1"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>Repository</span><span class='hs-varop'>.</span><span class='hs-conid'>Motd</span> <span class='hs-layout'>(</span><span class='hs-varid'>get_motd</span><span class='hs-layout'>,</span> <span class='hs-varid'>show_motd</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-2"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span> <span class='hs-layout'>(</span> <span class='hs-varid'>unless</span> <span class='hs-layout'>)</span>
<a name="line-3"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>Flags</span> <span class='hs-layout'>(</span> <span class='hs-conid'>DarcsFlag</span><span class='hs-layout'>(</span> <span class='hs-conid'>Quiet</span><span class='hs-layout'>,</span> <span class='hs-conid'>XMLOutput</span> <span class='hs-layout'>)</span> <span class='hs-layout'>)</span>
<a name="line-4"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>External</span> <span class='hs-layout'>(</span> <span class='hs-varid'>fetchFilePS</span><span class='hs-layout'>,</span> <span class='hs-conid'>Cachable</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span> <span class='hs-layout'>)</span>
<a name="line-5"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>Global</span> <span class='hs-layout'>(</span> <span class='hs-varid'>darcsdir</span> <span class='hs-layout'>)</span>
<a name="line-6"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>B</span> <span class='hs-layout'>(</span><span class='hs-varid'>null</span><span class='hs-layout'>,</span> <span class='hs-varid'>hPut</span><span class='hs-layout'>,</span> <span class='hs-varid'>empty</span><span class='hs-layout'>,</span> <span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span>
<a name="line-7"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Darcs</span><span class='hs-varop'>.</span><span class='hs-conid'>Utils</span> <span class='hs-layout'>(</span> <span class='hs-varid'>catchall</span> <span class='hs-layout'>)</span>
<a name="line-8"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span> <span class='hs-layout'>(</span> <span class='hs-varid'>stdout</span> <span class='hs-layout'>)</span>
</pre>\end{code}
\paragraph{motd}\label{motd}
The \verb!_darcs/prefs/motd! file may contain a ``message of the day''
which will be displayed to users who get or pull from the repository without the
\verb!--quiet! option.
\begin{code}
<pre><a name="line-1"></a><a name="get_motd"></a><span class='hs-comment'>-- | Fetch and return the message of the day for a given repository.</span>
<a name="line-2"></a><span class='hs-definition'>get_motd</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span>
<a name="line-3"></a><span class='hs-definition'>get_motd</span> <span class='hs-varid'>repo</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fetchFilePS</span> <span class='hs-layout'>(</span><span class='hs-varid'>repo</span><span class='hs-varop'>++</span><span class='hs-str'>"/"</span><span class='hs-varop'>++</span><span class='hs-varid'>darcsdir</span><span class='hs-varop'>++</span><span class='hs-str'>"/prefs/motd"</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>MaxAge</span> <span class='hs-num'>600</span><span class='hs-layout'>)</span>
<a name="line-4"></a> <span class='hs-varop'>`catchall`</span> <span class='hs-varid'>return</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>empty</span>
<a name="line-5"></a>
<a name="line-6"></a><a name="show_motd"></a><span class='hs-comment'>-- | Display the message of the day for a given repository,</span>
<a name="line-7"></a><span class='hs-comment'>-- unless either the 'XMLOutput' or the 'Quiet' flags are passed in</span>
<a name="line-8"></a><span class='hs-definition'>show_motd</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>DarcsFlag</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-9"></a><span class='hs-definition'>show_motd</span> <span class='hs-varid'>opts</span> <span class='hs-varid'>repo</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>unless</span> <span class='hs-layout'>(</span><span class='hs-conid'>Quiet</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>opts</span> <span class='hs-varop'>||</span> <span class='hs-conid'>XMLOutput</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>opts</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>do</span>
<a name="line-10"></a> <span class='hs-varid'>motd</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>get_motd</span> <span class='hs-varid'>repo</span>
<a name="line-11"></a> <span class='hs-varid'>unless</span> <span class='hs-layout'>(</span><span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>null</span> <span class='hs-varid'>motd</span><span class='hs-layout'>)</span>
<a name="line-12"></a> <span class='hs-varop'>$</span> <span class='hs-keyword'>do</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>hPut</span> <span class='hs-varid'>stdout</span> <span class='hs-varid'>motd</span>
<a name="line-13"></a> <span class='hs-varid'>putStrLn</span> <span class='hs-str'>"**********************"</span>
</pre>\end{code}
</body>
</html>
