banList.h

Engine/source/app/banList.h

More...

Classes:

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _BANLIST_H_
25#define _BANLIST_H_
26
27#ifndef _ENGINEAPI_H_
28   #include "console/engineAPI.h"
29#endif
30#ifndef _TVECTOR_H_
31   #include "core/util/tVector.h"
32#endif
33
34/// Helper class to keep track of bans.
35class BanList
36{
37   public:
38   
39      DECLARE_STATIC_CLASS( BanList );
40   
41      struct BanInfo
42      {
43         S32      uniqueId;
44         char     transportAddress[128];
45         S32      bannedUntil;
46      };
47      
48   protected:
49
50      Vector< BanInfo> list;
51      
52      static BanList* smInstance;
53
54   public:
55
56      BanList();
57      
58      static BanList* instance() { return smInstance; }
59
60      void addBan(S32 uniqueId, const char *TA, S32 banTime);
61      void addBanRelative(S32 uniqueId, const char *TA, S32 numSeconds);
62      void removeBan(S32 uniqueId, const char *TA);
63      bool isBanned(S32 uniqueId, const char *TA);
64      bool isTAEq(const char *bannedTA, const char *TA);
65      void exportToFile(const char *fileName);
66};
67
68#endif
69