"""QGIS Plugin Implementation."""

def __init__(self, iface):

"""Constructor.

:param iface: An interface instance that will be passed to this class

which provides the hook by which you can manipulate the QGIS

application at run time.

:type iface: QgsInterface

"""

# Save reference to the QGIS interface

self.iface = iface

# initialize plugin directory

self.plugin_dir = os.path.dirname(__file__)

# initialize locale

locale = QSettings().value('locale/userLocale')[0:2]

locale_path = os.path.join(

self.plugin_dir,

'i18n',

'BritNatGridRef_{}.qm'.format(locale))

if os.path.exists(locale_path):

self.translator = QTranslator()

self.translator.load(locale_path)

if qVersion() > '4.3.3':

QCoreApplication.installTranslator(self.translator)

# Create the dialog (after translation) and keep reference

self.dlg = BritNatGridRefDialog()

# Add actions

self.dlg.fileButton.clicked.connect(self.fileButtonClicked)

# Standard shortcut

self.dlg.fileButton.setShortcut('Ctrl+O')

# Declare instance attributes

self.actions = []

self.menu = self.tr(u'&BritNatGridRef')

self.toolbar = self.iface.addToolBar(u'BritNatGridRef')

self.toolbar.setObjectName(u'BritNatGridRef')

# Options for CSV files

self.lineCount = 0

self.CSVsOn = False

# Prep error messages

self.msgBadGrid = "Sorry, I could not process the request; incorrect grid reference format"

self.msgNoLayer = "Sorry, an error occurred - check there is a writable active layer"

# Make hashtable of eastings and northings by grid reference

self.east = {'HP':'4', 'HT':'3', 'HU':'4', 'HW':'1', 'HX':'2', 'HY':'3', 'HZ':'4', 'NA':'0', 'NB':'1', 'NC':'2', 'ND':'3', 'NF':'0', 'NG':'1', 'NH':'2', 'NJ':'3', 'NK':'4', 'NL':'0', 'NM':'1', 'NN':'2', 'NO':'3', 'NR':'1', 'NS':'2', 'NT':'3', 'NU':'4', 'NW':'1', 'NX':'2', 'NY':'3', 'NZ':'4', 'OV':'5', 'SC':'2', 'SD':'3', 'SE':'4', 'SH':'2', 'SJ':'3', 'SK':'4', 'SM':'1', 'SN':'2', 'SO':'3', 'SP':'4', 'SR':'1', 'SS':'2', 'ST':'3', 'SU':'4', 'SV':'0', 'SW':'1', 'SX':'2', 'SY':'3', 'SZ':'4', 'TA':'5', 'TF':'5', 'TG':'6', 'TL':'5', 'TM':'6', 'TQ':'5', 'TR':'6', 'TV':'5'}

self.north = {'HP':'12', 'HT':'11', 'HU':'11', 'HW':'10', 'HX':'10', 'HY':'10', 'HZ':'10', 'NA':'9', 'NB':'9', 'NC':'9', 'ND':'9', 'NF':'8', 'NG':'8', 'NH':'8', 'NJ':'8', 'NK':'8', 'NL':'7', 'NM':'7', 'NN':'7', 'NO':'7', 'NR':'6', 'NS':'6', 'NT':'6', 'NU':'6', 'NW':'5', 'NX':'5', 'NY':'5', 'NZ':'5', 'OV':'5', 'SC':'4', 'SD':'4', 'SE':'4', 'SH':'3', 'SJ':'3', 'SK':'3', 'SM':'2', 'SN':'2', 'SO':'2', 'SP':'2', 'SR':'1', 'SS':'1', 'ST':'1', 'SU':'1', 'SV':'0', 'SW':'0', 'SX':'0', 'SY':'0', 'SZ':'0', 'TA':'4', 'TF':'3', 'TG':'3', 'TL':'2', 'TM':'2', 'TQ':'1', 'TR':'1', 'TV':'0'}

def fileButtonClicked(self):

#Show file picker dialogue

fname = QFileDialog.getOpenFileName(self.dlg, 'Open file', '')

self.dlg.fileNameField.setText(fname)

# noinspection PyMethodMayBeStatic

def tr(self, message):

"""Get the translation for a string using Qt translation API.

We implement this ourselves since we do not inherit QObject.

:param message: String for translation.

:type message: str, QString

:returns: Translated version of message.

:rtype: QString

"""

# noinspection PyTypeChecker,PyArgumentList,PyCallByClass

return QCoreApplication.translate('BritNatGridRef', message)

def add_action(

self,

icon_path,

text,

callback,

enabled_flag=True,

add_to_menu=True,

add_to_toolbar=True,

status_tip=None,

whats_this=None,

parent=None):

"""Add a toolbar icon to the toolbar.

:param icon_path: Path to the icon for this action. Can be a resource

path (e.g. ':/plugins/foo/bar.png') or a normal file system path.

:type icon_path: str

:param text: Text that should be shown in menu items for this action.

:type text: str

:param callback: Function to be called when the action is triggered.

:type callback: function

:param enabled_flag: A flag indicating if the action should be enabled

by default. Defaults to True.

:type enabled_flag: bool

:param add_to_menu: Flag indicating whether the action should also

be added to the menu. Defaults to True.

:type add_to_menu: bool

:param add_to_toolbar: Flag indicating whether the action should also

be added to the toolbar. Defaults to True.

:type add_to_toolbar: bool

:param status_tip: Optional text to show in a popup when mouse pointer

hovers over the action.

:type status_tip: str

:param parent: Parent widget for the new action. Defaults None.

:type parent: QWidget

:param whats_this: Optional text to show in the status bar when the

mouse pointer hovers over the action.

:returns: The action that was created. Note that the action is also

added to self.actions list.

:rtype: QAction

"""

icon = QIcon(icon_path)

action = QAction(icon, text, parent)

action.triggered.connect(callback)

action.setEnabled(enabled_flag)

if status_tip is not None:

action.setStatusTip(status_tip)

if whats_this is not None:

action.setWhatsThis(whats_this)

if add_to_toolbar:

self.toolbar.addAction(action)

if add_to_menu:

self.iface.addPluginToMenu(

self.menu,

action)

self.actions.append(action)

return action

def initGui(self):

"""Create the menu entries and toolbar icons inside the QGIS GUI."""

icon_path = ':/plugins/BritNatGridRef/icon.png'

self.add_action(

icon_path,

text=self.tr(u'BritNatGridRef'),

callback=self.run,

parent=self.iface.mainWindow())

def unload(self):

"""Removes the plugin menu item and icon from QGIS GUI."""

for action in self.actions:

self.iface.removePluginMenu(

self.tr(u'&BritNatGridRef'),

action)

self.iface.removeToolBarIcon(action)

# remove the toolbar

del self.toolbar

def badGridError(self):

msg = self.msgBadGrid

# Be a bit more verbose with the CSV errors

if self.CSVsOn:

msg += " at line "

msg += self.lineCount

qgis.utils.iface.messageBar().pushMessage("Error", self.msgBadGrid, level=QgsMessageBar.CRITICAL)

def addPoint(self, ref, attrs):

refLen = len(ref)

if refLen > 3:

code = ref[0:2].upper()

#print code

e = self.east[code]

n = self.north[code]

#print "East: ", e, " North: ", n

# Should now have the northings and eastings values... now need to add some more precision

metres = ref[2:]

l = len(metres)

# print l

if l & 0x1: # bad news, shouldn't have an odd number of digits... bomb out!

self.badGridError()

return 1

else:

# Good news so far... even number of digits... split 'em in half and pad with zeroes

l /= 2

eMetres = metres[0:l]

while len(eMetres) < 5:

eMetres = eMetres + "0"

nMetres = metres[l:]

while len(nMetres) < 5:

nMetres = nMetres + "0"

# Add the metres onto the eastings and northings

e += eMetres

n += nMetres

# print e

# print n

# Great... now have out coordinates in QGIS acceptable format... add a new point

# Get active layer

layer = qgis.utils.iface.activeLayer()

caps = layer.dataProvider().capabilities()

if caps:

# Declare a feature

feat = QgsFeature()

# Add attributes

if len(attrs) > 0: # Just use comma delimited attList

attList = attrs.split(",")

# print attList

feat.setAttributes(attList)

# Add the points

feat.setGeometry(QgsGeometry.fromPoint(QgsPoint(int(e), int(n))))

res, outFeats = layer.dataProvider().addFeatures([feat])

if not res:

qgis.utils.iface.messageBar().pushMessage("Error", "An error occurred adding points", level=QgsMessageBar.CRITICAL)

self.stayOpen = False

return 1

# Must update the UI for user to enjoy the new points

layer.triggerRepaint()

else:

self.badGridError()

else:

self.badGridError()

return 1

# Must be OK

return 0

def run(self):

# Check hashtable actually returns something and no other funnies are caught

try:

# Stay open if required

self.stayOpen = True

while (self.stayOpen):

# show the dialog

self.dlg.show()

# Run the dialog event loop

result = self.dlg.exec_()

# See if OK was pressed

if result:

# get tab index

index = self.dlg.tabWidget.currentIndex();

# Single entry

if index == 0:

# Check if dialogue should stay open

self.stayOpen = self.dlg.addMore.isChecked()

# Get grid ref and attributes

ref = self.dlg.textGridRef.text()

attrs = self.dlg.textAttributes.text()

addOkay = self.addPoint(ref, attrs)

if addOkay != 0:

self.stayOpen = False

self.badGridError()

# Add CSV file

elif index == 1:

# Get the CSV file name'

csvFileName = self.dlg.fileNameField.text()

# Get the delimiter and ensure it's in ASCII bytes (not default Unicode)

delim = self.dlg.delimiterField.text()

delim = delim.encode('latin-1')

delimComma = True

if delim != ",":

delimComma = False

# print "delimComma: ", delimComma

# What column is the grid ref in (use index 1 for user friendliness)?

refCol = int(self.dlg.refColumnField.text())

refCol -= 1

# Check if a header row exists

hasHeader = self.dlg.headerRow.isChecked()

# Open CSV file using our own delimiter... which is probably still a comma

with open(csvFileName, 'rb') as csvfile:

r = csv.reader(csvfile, delimiter=delim)

j = 0

for row in r:

if (not hasHeader) or (j > 0):

# print ', '.join(row)

self.lineCount += 1

i = 0

gridRef = ""

attribs = ""

for cell in row:

if i == refCol:

gridRef = cell

else:

# When using a comma delimiter, don't want commas in the middle of a cell

aString = cell

#print aString

if delimComma:

aString = aString.replace(delim, ";")

attribs += aString

attribs += ","

i += 1

print gridRef

# Strip final comma

attribs = attribs.rstrip(",")

print attribs

# Now add to grid

addOK = self.addPoint(gridRef, attribs)

# Stop and report if an error occurs

if addOK != 0:

self.stayOpen = False

self.badGridError()

break

j += 1

self.stayOpen = False

else:

self.stayOpen = False

except KeyError, e:

self.badGridError()

print e

except AttributeError, e:

# Occurs when no layer is selected... could occur for other reasons... let me know :)

qgis.utils.iface.messageBar().pushMessage("Error", self.msgNoLayer, level=QgsMessageBar.CRITICAL)

print e